You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/doc_maintenance.rst
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,27 @@
1
1
Document Maintenance
2
2
====================
3
3
4
-
Sphinx
5
-
------
4
+
Document Software Setup
5
+
-----------------------
6
6
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
9
19
10
20
11
21
Clone AboutCode
12
22
---------------
13
23
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.
15
25
16
26
Open that directory and execute the following command in a terminal session::
17
27
@@ -23,14 +33,17 @@ Now you can install the dependencies in a virtualenv::
23
33
cd aboutcode
24
34
python3.6 -m venv .
25
35
source bin/activate
36
+
37
+
Now you can install Sphinx and the format theme used by readthedocs::
38
+
26
39
pip install Sphinx sphinx_rtd_theme
27
40
28
41
Now you can build the HTML documents locally::
29
42
30
43
cd docs
31
44
make html
32
45
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::
0 commit comments