{"id":24708249,"url":"https://github.com/clementlecorre/sphinx-alpine","last_synced_at":"2025-10-26T06:33:52.120Z","repository":{"id":104874002,"uuid":"90151951","full_name":"clementlecorre/sphinx-alpine","owner":"clementlecorre","description":"Sphinx is a tool that makes it easy to create intelligent and beautiful documentation","archived":false,"fork":false,"pushed_at":"2017-06-30T12:52:00.000Z","size":7,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T23:51:12.348Z","etag":null,"topics":["docker","python","sphinx-doc","sphinx-documentation"],"latest_commit_sha":null,"homepage":"http://cl3m3nt.me/sphinx-alpine/","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/clementlecorre.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-03T13:27:28.000Z","updated_at":"2025-02-14T07:33:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"ec96ba8d-618c-4704-a3cb-186515958e81","html_url":"https://github.com/clementlecorre/sphinx-alpine","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/clementlecorre/sphinx-alpine","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clementlecorre%2Fsphinx-alpine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clementlecorre%2Fsphinx-alpine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clementlecorre%2Fsphinx-alpine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clementlecorre%2Fsphinx-alpine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clementlecorre","download_url":"https://codeload.github.com/clementlecorre/sphinx-alpine/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clementlecorre%2Fsphinx-alpine/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001135,"owners_count":26083022,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-doc","sphinx-documentation"],"created_at":"2025-01-27T06:29:07.954Z","updated_at":"2025-10-09T09:31:56.390Z","avatar_url":"https://github.com/clementlecorre.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sphinx alpine\n\n\n[![Docker Automated buil](https://img.shields.io/docker/automated/cl3m3nt/sphinx.svg?style=flat-square)](https://hub.docker.com/r/cl3m3nt/sphinx/)\n[![Docker Build Statu](https://img.shields.io/docker/build/cl3m3nt/sphinx.svg?style=flat-square)](https://hub.docker.com/r/cl3m3nt/sphinx/)\n[![Docker Pulls](https://img.shields.io/docker/pulls/cl3m3nt/sphinx.svg?style=flat-square)](https://hub.docker.com/r/cl3m3nt/sphinx/)\n[![](https://images.microbadger.com/badges/image/cl3m3nt/sphinx.svg)](https://microbadger.com/images/cl3m3nt/sphinx \"Get your own image badge on microbadger.com\")\n\nInfo :\n\n*   [RST syntax](http://docutils.sourceforge.net/rst.html)\n*   [shinx](http://www.sphinx-doc.org/en/stable/)\n\nRequire :\n\n*   [Docker](https://www.docker.com)\n\n## How to start\n\nGenerate base project\n```\ndocker run -it -v ${PWD}/example/mydocs:/root/docs cl3m3nt/sphinx\n```\n\nAnswer the questions...\n```\n\u003e Root path for the documentation [.]:\n\u003e Separate source and build directories (y/n) [n]: y\n\u003e Name prefix for templates and static dir [_]:\n\u003e Project name: Test_project\n\u003e Author name(s): Cl3m3nt\n\u003e Project version: 0.1\n\u003e Project release [0.1]:\n\u003e Project language [en]:\n\n....\n```\n\nMy project base sphinx\n```\nuser@computer - ~/example/mydocs \u003e tree\n├── Makefile\n├── build\n├── make.bat\n└── source\n    ├── _static\n    ├── _templates\n    ├── conf.py\n    └── index.rst\n\n4 directories, 4 files\n```\n\n## Make docs\n\nAdd file `.rest` to source\n```\nexample/mydocs/source\n├── _static\n├── _templates\n├── conf.py\n├── index.rst\n└── test.rst\n```\n\nExemple for html..\n```\nuser@computer - ~/example/mydocs \u003e docker run -it -v ${PWD}/example/mydocs:/root/docs cl3m3nt/sphinx make html\nRunning Sphinx v1.5.5\nloading pickled environment... done\nbuilding [mo]: targets for 0 po files that are out of date\nbuilding [html]: targets for 1 source files that are out of date\nupdating environment: 0 added, 1 changed, 0 removed\nreading sources... [100%] test\nlooking for now-outdated files... none found\npickling environment... done\nchecking consistency... done\npreparing documents... done\nwriting output... [100%] test\ngenerating indices... genindex\nwriting additional pages... search\ncopying static files... done\ncopying extra files... done\ndumping search index in English (code: en) ... done\ndumping object inventory... done\nbuild succeeded.\n\nBuild finished. The HTML pages are in build/html.\n```\n\n\n### Other build\n\n| Type | Description |\n| :-------: |:------|\n|  html         | to make standalone HTML files |\n|  dirhtml      | to make HTML files named index.html in directories |\n|  singlehtml   | to make a single large HTML file |\n|  pickle       | to make pickle files |\n|  json         | to make JSON files |\n|  htmlhelp     | to make HTML files and an HTML help project |\n|  qthelp       | to make HTML files and a qthelp project |\n|  devhelp      | to make HTML files and a Devhelp project |\n|  epub         | to make an epub |\n|  latex        | to make LaTeX files, you can set PAPER=a4 or PAPER=letter |\n|  latexpdf     | to make LaTeX and PDF files (default pdflatex) |\n|  latexpdfja   | to make LaTeX files and run them through platex/dvipdfmx |\n|  text         | to make text files |\n|  man          | to make manual pages |\n|  texinfo      | to make Texinfo files |\n|  info         | to make Texinfo files and run them through makeinfo |\n|  gettext      | to make PO message catalogs |\n|  changes      | to make an overview of all changed/added/deprecated items |\n|  xml          | to make Docutils-native XML files |\n|  pseudoxml    | to make pseudoxml-XML files for display purposes |\n|  linkcheck    | to check all external links for integrity |\n|  doctest      | to run all doctests embedded in the documentation (if enabled) |\n|  coverage     | to run coverage check of the documentation (if enabled) |\n\n\n# Env variables\n\n## Sphinx-quickstart default value\n\n| Name | default value | Description |\n| :-------: |:------|:------|\n| _SPHINX_DEFAULT_THEME | alabaster | default theme |\n\n## Rewrite Sphinx-quickstart default value\n\n| Name | default value | Description |\n| :-------: |:------|:------|\n| SPHINX_DEFAULT_THEME | sphinx_rtd_theme | default theme |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclementlecorre%2Fsphinx-alpine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclementlecorre%2Fsphinx-alpine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclementlecorre%2Fsphinx-alpine/lists"}