readme: Getting started building docs locally
GitHub-Pull-Request: https://github.com/syncthing/docs/pull/164
This commit is contained in:
committed by
Jakob Borg
parent
5ac7ff99da
commit
c5796b993f
@@ -16,6 +16,15 @@ documentation team and perform edits without requiring approval.
|
|||||||
In the long run, learning to use Git_ and running Sphinx_ on your computer is
|
In the long run, learning to use Git_ and running Sphinx_ on your computer is
|
||||||
beneficial.
|
beneficial.
|
||||||
|
|
||||||
|
First steps to run is locally
|
||||||
|
::
|
||||||
|
|
||||||
|
git clone https://github.com/syncthing/docs.git
|
||||||
|
pip install -U Sphinx
|
||||||
|
cd docs
|
||||||
|
make html
|
||||||
|
# open _build/html/index.html
|
||||||
|
|
||||||
Structure
|
Structure
|
||||||
---------
|
---------
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user