{"id":20698455,"url":"https://github.com/openmediavault/openmediavault-docs","last_synced_at":"2025-04-22T21:46:42.280Z","repository":{"id":28231881,"uuid":"117550485","full_name":"openmediavault/openmediavault-docs","owner":"openmediavault","description":"openmediavault documentation","archived":false,"fork":false,"pushed_at":"2025-04-22T06:28:09.000Z","size":9914,"stargazers_count":67,"open_issues_count":1,"forks_count":70,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-04-22T07:44:05.497Z","etag":null,"topics":["documentation","sphinx"],"latest_commit_sha":null,"homepage":"https://docs.openmediavault.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openmediavault.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support.rst","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-15T13:42:13.000Z","updated_at":"2025-04-22T06:26:24.000Z","dependencies_parsed_at":"2024-01-16T15:32:40.704Z","dependency_job_id":"b7a4e1ef-d555-4c1a-87df-f56e54bd63cc","html_url":"https://github.com/openmediavault/openmediavault-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmediavault%2Fopenmediavault-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmediavault%2Fopenmediavault-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmediavault%2Fopenmediavault-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmediavault%2Fopenmediavault-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openmediavault","download_url":"https://codeload.github.com/openmediavault/openmediavault-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250330903,"owners_count":21413063,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","sphinx"],"created_at":"2024-11-17T00:24:48.238Z","updated_at":"2025-04-22T21:46:42.254Z","avatar_url":"https://github.com/openmediavault.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# openmediavault-docs\n\nCreating a virtual environment for Sphinx\n-----------------------------------------\n\nTo avoid polluting your development system you should create and use an isolated\nPython environment to install and use Sphinx.\n\nTo do so you need to install the Python virtualenv module. On Debian/Ubuntu you\ncan do this the following way:\n\n\t# apt-get install python3-virtualenv\n\nTo initially setup the virtual Python environment simply execute the following\nlines:\n\n\t$ make buildvenv\n\nBuild the HTML code\n-------------------\n\n\t$ make autobuild\n\nNow open \u003chttp://localhost:8080/\u003e in your browser to view the documentation.\nAny changes to the documentation code will be rendered now immediatelly.\n\nCleanup the HTML code\n---------------------\n\n\t$ make clean\n\nreStructured text cheat-sheets\n------------------------------\n* http://www.sphinx-doc.org/en/stable/rest.html\n* http://docutils.sourceforge.net/docs/user/rst/quickref.html\n* https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst\n* https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html\n\nContribute\n----------\nTo contribute to the documentation simply clone this repository, make your\nchanges and create a PR (pull request).\n\nLicense\n-------\n[CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmediavault%2Fopenmediavault-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenmediavault%2Fopenmediavault-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmediavault%2Fopenmediavault-docs/lists"}