{"repo":"documatt/sphinx-doc-template","free":true,"listed":false,"github":"https://github.com/documatt/sphinx-doc-template","clone":"git clone https://github.com/documatt/sphinx-doc-template.git","description":"A Copier template for creating a modern Sphinx documentation project. Write in Markdown or reStructuredText, translate to multiple languages, boost with popular extensions, and enjoy automatic live reload on change.","language":"JavaScript","stars":14,"topics":["sphinx-doc","markdown","restructuredtext","copier-python","copier-template","template"],"license":"MIT","category":"machine-learning","readme_excerpt":"Sphinx Documentation Template An opinionated Copier template for creating a modern Sphinx documentation project. Write in Markdown or reStructuredText, translate to multiple languages, boost with popular extensions, and enjoy automatic live reload on change. Default blank Sphinx documentation projects require extensive configuration, fine-tuning, and trial and error to achieve optimal results. This template embodies the best practices and expertise gained through Documatt's technical writing services. 📚 Documentation · 📟 Source code The repository is the Copier template. Copier is a command-line tool for creating projects from templates. It requires Python installed but no knowledge of Python to use. The recommended way to install the Copier is uv. The uv can even install Python if you don't already have it. With uv installed, open the terminal and Answer the series of questions, and you are ready to go. You have the skeleton of a completely functional Sphinx project in my-new-docs folder in just a few moments. 🍿 Watch Key Features The Sphinx documentation template key features: - 💯 Free & open-source. - ✍️ Write in Markdown or reStructuredText. - 🏗️ Comes with popular Sphinx extension for sitemaps, redirects, diagrams, etc. - 👅 Localization (i18n) support. - 😀 Sane configuration defaults and best practices. - 🎨 VS Code support: recommended extensions, settings and formatting. - ⚒️ Live reload on change. - 💾 Build to multiple outputs. - 👍 Works out-of-the-box. Learn","default_branch":null,"files":null,"tree":[],"storefront":"/r/documatt","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/documatt/sphinx-doc-template/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}