mirrors/nextcloud-desktop
1
0
Fork 0
mirror of https://github.com/nextcloud/desktop.git synced 2024-11-24 05:55:59 +03:00
Code Issues Projects Releases Packages Wiki Activity

Add README with instructions on how to build the documentation.

Browse source 
Signed-off-by: Camila <hello@camila.codes>
This commit is contained in:
Camila 2020-09-08 15:09:31 +02:00 committed by Camila (Rebase PR Action)
parent fecc62b7e1
commit 0f03e3091d
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/README.md Normal file
View file

@ -0,0 +1,17 @@
# Desktop client documentation
- The main nextcloud Documentation is found at https://github.com/nextcloud/documentation
- The rst files from the current stable branch will be parsed with sphinx to be used at https://docs.nextcloud.com/desktop/3.0/
## How to build the documentation
- After installing [sphinx](https://www.sphinx-doc.org) you can run:
```
$ git clone https://github.com/nextcloud/desktop.git
$ cd desktop
$ cd docs
$ sphinx-build -b html -D html_theme='nextcloud_com' -d _build/doctrees . _build/html/com
```
The documentation html files will be at ```desktop/docs/_build/html/com```.