{"id":25086766,"url":"https://github.com/yinchi/sphinx-autodoc-example","last_synced_at":"2025-07-11T11:35:19.525Z","repository":{"id":187147518,"uuid":"623175018","full_name":"yinchi/sphinx-autodoc-example","owner":"yinchi","description":"Sphinx autodoc example using Docker","archived":false,"fork":false,"pushed_at":"2023-04-03T21:07:02.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T14:49:35.175Z","etag":null,"topics":["docker","python","sphinx-autoapi","sphinx-autodoc"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yinchi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-04-03T21:06:59.000Z","updated_at":"2023-04-04T08:49:36.000Z","dependencies_parsed_at":"2023-08-09T06:39:33.237Z","dependency_job_id":null,"html_url":"https://github.com/yinchi/sphinx-autodoc-example","commit_stats":null,"previous_names":["yinchi/sphinx-autodoc-example"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yinchi/sphinx-autodoc-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinchi%2Fsphinx-autodoc-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinchi%2Fsphinx-autodoc-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinchi%2Fsphinx-autodoc-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinchi%2Fsphinx-autodoc-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yinchi","download_url":"https://codeload.github.com/yinchi/sphinx-autodoc-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinchi%2Fsphinx-autodoc-example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264795838,"owners_count":23665241,"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":["docker","python","sphinx-autoapi","sphinx-autodoc"],"created_at":"2025-02-07T09:19:00.002Z","updated_at":"2025-07-11T11:35:19.502Z","avatar_url":"https://github.com/yinchi.png","language":"Python","readme":"# Sphinx autodoc Docker example\n\nThis repo can be used as a template for a Python project with [Sphinx](https://www.sphinx-doc.org/) documentation.\n\n## Installing Docker Desktop\n\nThis project was tested using Docker Desktop on Windows 11 with a WSL2 engine. See \u003chttps://docs.docker.com/desktop/windows/wsl/\u003e.\n\n## Available services\n\n- **bash** -- Use `docker compose run --rm bash` to launch a `bash` shell or `docker compose run --rm bash \u003ccmd\u003e` to run a single command.\n- **sphinx** -- Use `docker compose up sphinx -d` to launch a simple webserver to serve project's documentation.  This also regenerates the documentation from scratch using `doc-clean` and `doc-build`.  The webserver can also be launched by running the `doc-serve` script in a `bash` shell.\n\nBoth services will mount the project's `app` directory as `/app` within the Docker container, allowing changes in the host machine to be reflected in the Docker containers and vice versa.\n\nNote that Sphinx will **not** automatically update to reflect changes to project code in `app`. However, `doc-clean` and `doc-build` can be run in `bash` without shutting down a running Sphinx service.\n\n## Installing dependencies\n\nThe Docker images generated by this project will run `pip install -r /requirements.txt` during the build.\n\n## Enabled Sphinx extensions\n\n### autodoc\n\nThis project generates ReStructuredText documentation from Python docstrings using `autodoc`. The generated `.rst` files are in `docs/source/apidoc`. The files are generated automatically by `doc-build` and `doc-clean` will remove them.\n\n### Intersphinx \u0026mdash; Linking to external documentation\n\nThis project uses the `sphinx.ext.intersphinx` extension to link to external Sphinx documentation. Setup for Intersphinx is performed using the `intersphinx_mapping` variable in `app/docs/source/conf.py`.\n\n### MathJax \u0026mdash; LaTeX support\n\nThe `sphinx.ext.mathjax` extension is enabled to allow for LaTeX markup in the documentation. Disable this in `app/docs/source/conf.py` if not needed.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyinchi%2Fsphinx-autodoc-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyinchi%2Fsphinx-autodoc-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyinchi%2Fsphinx-autodoc-example/lists"}