Skip to content

Commit

Permalink
Correct doc level and copyright year (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhongjiajie authored Oct 12, 2023
1 parent 143e9ba commit cb694c9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from stmdency import __version__ # noqa

project = "stmdency"
copyright = "2022, Jay Chung"
copyright = "2023, Jay Chung"
author = "Jay Chung"
release = __version__

Expand Down
15 changes: 8 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,29 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Stmdency's Documentation
========================
Stmdency
========

Stmdency, **ST** ate **M** ents depen **DENCY**, a tool handling python statements' dependencies, can
extract dependencies from Python statements according to the given statement identifier.

Installation
------------
============

Stmdency can be installed from PyPI using pip:

.. code-block:: bash
python -m pip install --upgrade stmdency
Usage
-----
=====

Stmdency can be used as a Python module(as a command line tool will coming soon).

Extract Variable Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------

Let's say we have a python code like below, we define a variable ``a`` and ``b`` and ``b`` depends on ``a``:

Expand Down Expand Up @@ -59,7 +60,7 @@ The result will be:
Extract Function Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------

Stmdency not only can extract variable dependencies, but also can extract function dependencies. Suppose we
have the script below.
Expand Down Expand Up @@ -111,7 +112,7 @@ The result will be:
bar(b)
Python Code in File
~~~~~~~~~~~~~~~~~~~
-------------------

As you can see, we use a string to represent the Python code in the above examples. But in most cases, our code
is in a file. Stmdency can also handle this situation.
Expand Down

0 comments on commit cb694c9

Please sign in to comment.