mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-24 00:37:56 +00:00
Code Issues Releases Wiki Activity

docs: development: update docs remarks

Browse source
This commit is contained in:
Marian Beermann 2017-06-18 01:31:32 +02:00
parent 7df1140ab9
commit 887df51eef
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/development.rst
View file

@ -237,9 +237,10 @@ Building the docs with Sphinx
The documentation (in reStructuredText format, .rst) is in docs/. The documentation (in reStructuredText format, .rst) is in docs/.
To build the html version of it, you need to have sphinx installed:: To build the html version of it, you need to have Sphinx installed
(in your Borg virtualenv with Python 3)::
pip3 install sphinx sphinx_rtd_theme # important: this will install sphinx with Python 3 pip install -r requirements.d/docs.txt
Now run:: Now run::
@ -248,7 +249,7 @@ Now run::
Then point a web browser at docs/_build/html/index.html. Then point a web browser at docs/_build/html/index.html.
The website is updated automatically through Github web hooks on the The website is updated automatically by ReadTheDocs through GitHub web hooks on the
main repository. main repository.
Using Vagrant Using Vagrant