Skip to content

Commit

Permalink
Update main docs page (#24)
Browse files Browse the repository at this point in the history
* Update main docs page

* docs: update module docstring
  • Loading branch information
Lewiscowles1986 authored Apr 9, 2024
1 parent 7370339 commit 63ff7b0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Welcome! Python Call Graph is a [Python](http://www.python.org) module that creates [call graph](http://en.wikipedia.org/wiki/Call_graph) visualizations for Python applications.

This repo used to be `pycallgraph` which is still hosted at pypi [link](https://pypi.org/project/pycallgraph/).
This repo used to be `pycallgraph` which is still hosted at pypi [link](https://pypi.org/project/python-call-graph/).

The uploader makes no representations of their contribution, and merely wanted this to work in python 3.5; with a goal to porting it to 3.11 and 3.12

Expand Down Expand Up @@ -45,7 +45,7 @@ pip install python-call-graph

```

You can either use the [command-line interface](https://pycallgraph.readthedocs.io/en/develop/guide/command_line_usage.html) for a quick visualization of your Python script, or the [pycallgraph module](https://pycallgraph.readthedocs.io/en/develop/api/pycallgraph.html) for more fine-grained settings.
You can either use the [command-line interface](https://lewiscowles1986.github.io/py-call-graph/guide/command_line_usage.html) for a quick visualization of your Python script, or the [pycallgraph module](https://lewiscowles1986.github.io/py-call-graph/api/pycallgraph.html) for more fine-grained settings.

The following examples specify graphviz as the outputter, so it's required to be installed. They will generate a file called `pycallgraph.png`.

Expand All @@ -69,4 +69,4 @@ with PyCallGraph(output=GraphvizOutput()):

## Documentation

Feel free to browse the [documentation of pycallgraph](https://pycallgraph.readthedocs.io/en/develop/) for the [usage guide](https://pycallgraph.readthedocs.io/en/develop/guide/index.html) and [API reference](https://pycallgraph.readthedocs.io/en/develop/api/api.html).
Feel free to browse the [documentation of pycallgraph](https://lewiscowles1986.github.io/py-call-graph/) for the [usage guide](https://lewiscowles1986.github.io/py-call-graph/guide/index.html) and [API reference](https://lewiscowles1986.github.io/py-call-graph/api/api.html).
2 changes: 1 addition & 1 deletion pycallgraph/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
This is a fork of the original, updated to work with Python 3.5 - 3.11 and from 2.1.0 3.8 - 3.12
See https://pycallgraph.readthedocs.io/en/develop/ for more information.
See https://lewiscowles1986.github.io/py-call-graph/ for more information.
'''
from .metadata import __version__
from .metadata import __copyright__
Expand Down

0 comments on commit 63ff7b0

Please sign in to comment.