summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTAKAHASHI Shuuji2022-12-05 01:31:44 +0900
committerGitHub2022-12-04 09:31:44 -0700
commit0efa4456051e97040c750d5927304ad4db49bf24 (patch)
tree0a865606d5ebbc7b9bfe4cefd9c21f325434e6e5 /docs
parent3028e83f528134bd6937b529668f56b9ab565bdf (diff)
downloadtakahe-0efa4456051e97040c750d5927304ad4db49bf24.tar.gz
takahe-0efa4456051e97040c750d5927304ad4db49bf24.tar.bz2
takahe-0efa4456051e97040c750d5927304ad4db49bf24.zip
Added "Building Documentation" section (#101)
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index a2e4251..49e53ed 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -121,6 +121,26 @@ And you can run the tests with pytest::
If you want to edit settings, you can edit the ``.env`` file.
+Building Documentation
+----------------------
+
+We are using `Sphinx <https://www.sphinx-doc.org/en/master/index.html>`_ and `reStructuredText markup language <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ to write documentation.
+
+To build documentation, we need to install additional libraries::
+
+ pip install -r docs/requirements.txt
+
+After editing documentation, you can build documentation with the following command::
+
+ make docs
+
+This outputs HTML files under the ``docs/_build/html/`` directory. Let's launch a development server to serve HTML files::
+
+ python -m http.server 8000 --directory docs/_build/html/
+
+Now, you can view the documentation on your browser at http://localhost:8000/.
+
+
Coding Guidelines
-----------------