{"id":30740985,"url":"https://github.com/justwheel/sphinx-docs-opinionated-quickstart","last_synced_at":"2025-09-04T00:18:33.074Z","repository":{"id":50180783,"uuid":"156258035","full_name":"justwheel/sphinx-docs-opinionated-quickstart","owner":"justwheel","description":"Pre-configured template repository to integrate Sphinx-based documentation into a project with Travis CI and ReadTheDocs.org support","archived":false,"fork":false,"pushed_at":"2022-12-08T03:14:23.000Z","size":62,"stargazers_count":3,"open_issues_count":5,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-01T17:58:48.443Z","etag":null,"topics":["documentation","python","python3","quickstart","read-the-docs","readthedocs","sphinx","sphinx-doc","sphinx-documentation","toolchain","tooling","travis-ci"],"latest_commit_sha":null,"homepage":"https://readthedocs.org/projects/sphinx-docs-opinionated-quickstart/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/justwheel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-05T17:41:01.000Z","updated_at":"2024-07-15T15:56:09.000Z","dependencies_parsed_at":"2023-01-24T07:10:19.195Z","dependency_job_id":null,"html_url":"https://github.com/justwheel/sphinx-docs-opinionated-quickstart","commit_stats":null,"previous_names":["justjwheelin/sphinx-docs-opinionated-quickstart","justwheel/sphinx-docs-opinionated-quickstart"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/justwheel/sphinx-docs-opinionated-quickstart","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justwheel%2Fsphinx-docs-opinionated-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justwheel%2Fsphinx-docs-opinionated-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justwheel%2Fsphinx-docs-opinionated-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justwheel%2Fsphinx-docs-opinionated-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/justwheel","download_url":"https://codeload.github.com/justwheel/sphinx-docs-opinionated-quickstart/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justwheel%2Fsphinx-docs-opinionated-quickstart/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273530726,"owners_count":25122052,"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-09-03T02:00:09.631Z","response_time":76,"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":["documentation","python","python3","quickstart","read-the-docs","readthedocs","sphinx","sphinx-doc","sphinx-documentation","toolchain","tooling","travis-ci"],"created_at":"2025-09-04T00:18:30.562Z","updated_at":"2025-09-04T00:18:33.064Z","avatar_url":"https://github.com/justwheel.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"sphinx-docs-opinionated-quickstart\n==================================\n\n[![License: BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![Build Status](https://travis-ci.com/jwflory/sphinx-docs-opinionated-quickstart.svg?branch=master)](https://travis-ci.com/jwflory/sphinx-docs-opinionated-quickstart)\n[![Documentation Status](https://readthedocs.org/projects/sphinx-docs-opinionated-quickstart/badge/?version=latest)](https://sphinx-docs-opinionated-quickstart.readthedocs.io/en/latest/?badge=latest)\n\nQuick-start, opinionated template repository to add [Sphinx-based documentation](http://www.sphinx-doc.org/) to an existing project\n\n\n## About\n\nThis repository is a working implementation of a documentation toolchain powered by [Sphinx](http://www.sphinx-doc.org/).\nUse these files to quickly set up Sphinx inside of an existing project.\nFor convenience, most of the special sauce is inside the `docs/` directory, so you can copy it straight into another project.\n\n### \"But I thought Sphinx had a quickstart tool already.\"\n\nYes, it does.\nBut I have opinions.\nAnd I am lazy.\nSo, when I am starting a new project, I want to use a preferred configuration instead of starting from the ground up.\nSometimes, you may want to start from the ground up.\nSo try that first if you like.\n\nBut if you are like me, and want to do more writing and less configuring, make your life easier and use a common base.\nThis repo is all about getting you to spend more time on what deserves your time, not getting lost in configuration options. :tada:\n\n\n## About reusing this repo\n\nThis repository is licensed under the [BSD 3-Clause License](https://choosealicense.com/licenses/bsd-3-clause/ \"BSD 3-Clause “New” or “Revised” License\").\nReuse anything you want in your own projects.\nIf you use this quickstart repo in a public repository, a link back here in your README is appreciated. :+1:\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustwheel%2Fsphinx-docs-opinionated-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjustwheel%2Fsphinx-docs-opinionated-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustwheel%2Fsphinx-docs-opinionated-quickstart/lists"}