aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/readme.rst
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2023-07-23 15:28:55 +0800
committer简律纯 <i@jyunko.cn>2023-07-23 15:28:55 +0800
commit8e79582d3a340ede3337759c5be06234689ccf4e (patch)
tree4808937a5da1248c03d3d8ee2f0e2f569ed05bb2 /readme.rst
parentdfa7eb4530d4b4062db8427a5b1b32ea5af7fb40 (diff)
downloadTRPGNivis-8e79582d3a340ede3337759c5be06234689ccf4e.tar.gz
TRPGNivis-8e79582d3a340ede3337759c5be06234689ccf4e.zip
😎BREAKING CHANGES
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/readme.rst b/readme.rst
index 445b680..739daf2 100644
--- a/readme.rst
+++ b/readme.rst
@@ -23,7 +23,7 @@ Features
- `Documentation Module`_: This module uses reStructuredText and Sphinx to build the documentation, providing API interface descriptions and usage examples.
.. _`Lexer Module`: https://github.com/HydroRoll-Team/psi/blob/main/psi/lexer.py
-.. _`Parser Module`: https://github.com/HydroRoll-Team/psi/blob/main/psi/parser.py
+.. _`Parser Module`: https://github.com/HydroRoll-Team/psi/blob/main/psi/parsers.py
.. _`Built-in Types Module`: https://github.com/HydroRoll-Team/psi/blob/main/psi/type.py
.. _`Error Handling Module`: https://github.com/HydroRoll-Team/psi/blob/main/psi/exception.py
.. _`Execution Environment Module`: https://github.com/HydroRoll-Team/psi/blob/main/psi/execution.py
@@ -67,6 +67,13 @@ Contributing
Contributions to the Psi project are welcome. If you have a feature request, bug report, or proposal for improvement, please open an issue on the project's GitHub page. If you wish to contribute code, please fork the repository and submit a pull request.
+How to build docs
+^^^^^^^^^^^^^^^^^
+
+ git clone https://github.com/HydroRoll-Team/psi.git
+ cd psi/psi/docs
+ sphinx-build -b html . _build/html
+
License
-------