Skip to content

Commit 093261e

Browse files
author
DennisClark
committed
Explain and simplify the Sphinx setup procedure
1 parent a26db70 commit 093261e

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

docs/source/doc_maintenance.rst

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
Document Maintenance
22
====================
33

4-
Sphinx
5-
------
4+
Document Software Setup
5+
-----------------------
66

7-
Install Sphinx on your local machine.
8-
See http://www.sphinx-doc.org/en/master/usage/installation.html
7+
AboutCode documentation is built using Sphinx.
8+
See http://www.sphinx-doc.org/en/master/index.html
9+
10+
AboutCode documentation is distributed using "Read the Docs".
11+
See https://readthedocs.org/
12+
13+
Individual document files are in reStructuredText format.
14+
See http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
15+
16+
You create, build, and preview AboutCode documentation on your local machine.
17+
18+
You commit your updates to the AboutCode repository on GitHub, which triggers an automatic rebuild of https://aboutcode.readthedocs.io/en/latest/index.html
919

1020

1121
Clone AboutCode
1222
---------------
1323

14-
Create or identify a working directory on your local machine.
24+
To get started, create or identify a working directory on your local machine.
1525

1626
Open that directory and execute the following command in a terminal session::
1727

@@ -23,14 +33,17 @@ Now you can install the dependencies in a virtualenv::
2333
cd aboutcode
2434
python3.6 -m venv .
2535
source bin/activate
36+
37+
Now you can install Sphinx and the format theme used by readthedocs::
38+
2639
pip install Sphinx sphinx_rtd_theme
2740

2841
Now you can build the HTML documents locally::
2942

3043
cd docs
3144
make html
3245

33-
Assuming that your Sphinx installation was successful, Sphinx should build a local instance of the documentaiton .html files::
46+
Assuming that your Sphinx installation was successful, Sphinx should build a local instance of the documentation .html files::
3447

3548
open build/html/index.html
3649

0 commit comments

Comments
 (0)