https://github.com/openmediavault/openmediavault-docs
openmediavault documentation
https://github.com/openmediavault/openmediavault-docs
documentation sphinx
Last synced: about 1 year ago
JSON representation
openmediavault documentation
- Host: GitHub
- URL: https://github.com/openmediavault/openmediavault-docs
- Owner: openmediavault
- License: other
- Created: 2018-01-15T13:42:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-22T06:28:09.000Z (about 1 year ago)
- Last Synced: 2025-04-22T07:44:05.497Z (about 1 year ago)
- Topics: documentation, sphinx
- Language: Python
- Homepage: https://docs.openmediavault.org
- Size: 9.45 MB
- Stars: 67
- Watchers: 15
- Forks: 70
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support.rst
Awesome Lists containing this project
README
# openmediavault-docs
Creating a virtual environment for Sphinx
-----------------------------------------
To avoid polluting your development system you should create and use an isolated
Python environment to install and use Sphinx.
To do so you need to install the Python virtualenv module. On Debian/Ubuntu you
can do this the following way:
# apt-get install python3-virtualenv
To initially setup the virtual Python environment simply execute the following
lines:
$ make buildvenv
Build the HTML code
-------------------
$ make autobuild
Now open in your browser to view the documentation.
Any changes to the documentation code will be rendered now immediatelly.
Cleanup the HTML code
---------------------
$ make clean
reStructured text cheat-sheets
------------------------------
* http://www.sphinx-doc.org/en/stable/rest.html
* http://docutils.sourceforge.net/docs/user/rst/quickref.html
* https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
* https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
Contribute
----------
To contribute to the documentation simply clone this repository, make your
changes and create a PR (pull request).
License
-------
[CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)