Skip to content

openmediavault/openmediavault-docs

Folders and files

NameName
Last commit message
Last commit date
Oct 16, 2022
Jan 18, 2018
Jan 12, 2025
Jan 12, 2025
Dec 4, 2024
Jul 5, 2024
Jul 8, 2021
Nov 22, 2019
Nov 3, 2023
Oct 16, 2022
Jan 15, 2018
Oct 16, 2022
Dec 25, 2021
Mar 3, 2024
May 6, 2021
Feb 11, 2023
Nov 6, 2023
May 29, 2023
Feb 25, 2018
Dec 30, 2024
Jan 24, 2025
Jan 19, 2018
Jul 9, 2024
Oct 16, 2022
Feb 24, 2023
Oct 16, 2022

Repository files navigation

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 http://localhost:8080/ 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

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