📘 Nextcloud documentation
Documentation is published on. To edit it yourself, you need to tinker a bit with Git and Sphinx. See the `Style Guide <https://github.com/nextcloud/documentation/blob/master/styleguide.rst>`_ for formatting and style conventions.
This repository hosts three manuals:
Please work in the appropriate branch:
stable-branches are for the respective release (e.g. 14.0 or 15.0),
masteris the latest version.
Please wrap lines at 80 characters.
configuration_server/config_sample_php_parameters.rstis auto-generated from the core config.sample.php file; changes to this file must be made in core _
As this grows it may be moved to its own page.
All documentation in this repository is licensed under the Creative Commons Attribution 3.0 Unported license (
CC BY 3.0_).
.. CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.enUS
Source files are written using the
Sphinx Documentation Generator. The syntax follows the
reStructuredTextstyle, and can also be edited from GitHub.
Contributing to the documentation requires a GitHub account. Make sure you are working in the correct branch for your version of Nextcloud or client apps. If your edits pertain to multiple manual versions, be prepared to backport as needed.
To edit a document, you can edit the .rst files on your local system, or work directly on GitHub. The latter is only suitable for small fixes and improvements because substantial editing efforts can better be controlled on your local PC.
The best way is to install a complete Sphinx build environment and work on your local PC. You will be able to make your own local builds, which is the fastest and best way to preview for errors. Sphinx will report syntax errors, missing images, and formatting errors. The GitHub preview is not complete and misses many mistakes. Create a new branch against the master or stable branch you are editing, make your edits, then push your new branch to GitHub and open a new PR.
To edit on GitHub, fork the repository (see top-right of the screen, under your username). You will then be able to make changes easily. Once done, you can create a pull request and get the changes reviewed and back into the official repository.
When editing either on your own local PC or on GitHub, be sure to sign of commits, to certify adherence to the Developer Certificate of Origin, see https://github.com/probot/dco . Your commit messages need to have, the name and email address of the contributor.
Signed-off-by: Awesome Contributor [email protected]
If using the command line and your name and email are configured, you can use
git commit -s -m 'Commit message'
In both settings be sure that your email address matches that in your GitHub profile, which if you have privacy enabled will be [email protected]
Help translate the documentation_.
For developers that want to ease the translation process, please read
pipenv --python 3.9
pip install -r requirements.txt
make ...to build all the stuff - for example
make htmlto build the HTML flavor of all manuals
To change into this environment you need to run
pipenv shellto launch the shell and to exit you can use either
When editing the documentation installing
sphinx-autobuildthough pip can be helpful. This will watch file changes and automatically reload the html preview:
pip install sphinx-autobuild
make SPHINXBUILD=sphinx-autobuild html
To compile and update the icons list in the designer manual, you will also need
.. CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.enUS .. _
Xcode command line tools: https://stackoverflow.com/questions/9329243/xcode-install-command-line-tools