{"id":26093161,"url":"https://github.com/richmetellus/docs_sphinxdoctemplate","last_synced_at":"2026-04-09T18:04:11.215Z","repository":{"id":280960519,"uuid":"943033331","full_name":"richMetellus/docs_SphinxDocTemplate","owner":"richMetellus","description":"This is a template to start writing project documentation using Sphinx","archived":false,"fork":false,"pushed_at":"2025-03-06T07:53:39.000Z","size":10440,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T08:33:14.848Z","etag":null,"topics":["documentation","markdown","python-sphinx","restructuredtext","sphinx","sphinx-doc"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/richMetellus.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":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-05T04:18:06.000Z","updated_at":"2025-03-06T07:53:42.000Z","dependencies_parsed_at":"2025-03-06T08:44:27.189Z","dependency_job_id":null,"html_url":"https://github.com/richMetellus/docs_SphinxDocTemplate","commit_stats":null,"previous_names":["richmetellus/docs_sphinxdoctemplate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richMetellus%2Fdocs_SphinxDocTemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richMetellus%2Fdocs_SphinxDocTemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richMetellus%2Fdocs_SphinxDocTemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richMetellus%2Fdocs_SphinxDocTemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/richMetellus","download_url":"https://codeload.github.com/richMetellus/docs_SphinxDocTemplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242685874,"owners_count":20169243,"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","markdown","python-sphinx","restructuredtext","sphinx","sphinx-doc"],"created_at":"2025-03-09T11:55:42.511Z","updated_at":"2025-12-04T22:06:06.820Z","avatar_url":"https://github.com/richMetellus.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sphinx Documentation Template\n\nThis is a very useful template I used for creating documentation using\npython sphinx.\n\n## Get Started\n\nYou only need to install `python` and install `pipenv` as the initial requirements.\n\n1. Install python and `pip`\n2. Then use `pip` to install `pipenv`\n\n   ```console\n   pip install pipenv --user\n   ```\n\n3. Additionally, install GNU make on your host machine\n\nOnce these two are install. To build the document you need to run the following commands\n\n1. Install the python packages and start a python virtual environment:\n\n    ```python\n    pipenv install\n    pipenv shell\n    ```\n\n2. then build the document: open a terminal at the root folder of the document\n   and then type the following command to build a live document\n\n    ```python\n    make livehtml\n    ```\n\nFor more information, see the file\n\n```{eval-rst}\n- :doc:`index`\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichmetellus%2Fdocs_sphinxdoctemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frichmetellus%2Fdocs_sphinxdoctemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichmetellus%2Fdocs_sphinxdoctemplate/lists"}