From cb694c9a54c11ba4deee2d30443e58d019e2233c Mon Sep 17 00:00:00 2001 From: Jay Chung Date: Thu, 12 Oct 2023 17:02:43 +0800 Subject: [PATCH] Correct doc level and copyright year (#23) --- docs/conf.py | 2 +- docs/index.rst | 15 ++++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e0d0981..7f1fd2f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,7 @@ from stmdency import __version__ # noqa project = "stmdency" -copyright = "2022, Jay Chung" +copyright = "2023, Jay Chung" author = "Jay Chung" release = __version__ diff --git a/docs/index.rst b/docs/index.rst index 55d7fb6..0e5b7b7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,14 +3,14 @@ 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: @@ -18,13 +18,14 @@ Stmdency can be installed from PyPI using pip: 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``: @@ -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. @@ -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.