README.rst

=======================Nextcloud Documentation=======================

Documentation is published on `<https://docs.nextcloud.com>`_.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/style_guide.rst>`_ for formatting and style conventions.

Manuals-------

This repository hosts three manuals:

* **Users' Manual*** **Administration Manual*** **Developers Manual**

Please work in the appropriate branch: ``stable``-branches are for the respective release (e.g. 14.0 or 15.0), ``master`` is the latest version.

Please wrap lines at 80 characters.

.. note:: ``configuration_server/config_sample_php_parameters.rst`` is auto-generated from the core config.sample.php file; changes to this file must be made in core `<https://github.com/nextcloud/server/tree/master/config>`_

All documentation in this repository is licensed under the Creative CommonsAttribution 3.0 Unported license (`CC BY 3.0`_).

.. _CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.en_US

Style-----

Source files are written using the `Sphinx Documentation Generator<https://www.sphinx-doc.org/en/master/>`_. The syntax follows the `reStructuredText<http://docutils.sourceforge.net/rst.html>`_ style, and can also be editedfrom GitHub.

Editing-------

Contributing to the documentation requires a Github account. Make sure you areworking in the correct branch for your version of Nextcloud or client apps.If your edits pertain to multiple manual versions, be prepared to backport asneeded.

To edit a document, you can edit the .rst files on your local system, or workdirectly on Github. The latter is only suitable for small fixes and improvementsbecause 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 yourlocal PC. You will be able to make your own local builds, which is the fastestand best way to preview for errors. Sphinx will report syntax errors, missingimages, and formatting errors. The Github preview is not complete and missesmany mistakes. Create a new branch against the master or stable branch you areediting, 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, underyour 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 intothe official repository.

Building--------

1. Install `pipenv` - https://pipenv.readthedocs.io/en/latest/2. Create a Python 2 environment (typically inside this repository): `pipenv --two`3. Change into the environment: `pipenv shell`4. Install the dependencies `pip2 install -r requirements.txt`5. Now you can use `make ...` to build all the stuff - for example `make html` to build the HTML flavor of all manuals

To change into this environment you need to run `pipenv shell` to launch the shell and to exit you can use either `exit` or `Ctrl` + `D`.

Icons-----

To compile and update the icons list in the designer manual, you will also need