https://github.com/jwflory/sphinx-docs-opinionated-quickstart

Pre-configured template repository to integrate Sphinx-based documentation into a project with Travis CI and ReadTheDocs.org support
https://github.com/jwflory/sphinx-docs-opinionated-quickstart

documentation python python3 quickstart read-the-docs readthedocs sphinx sphinx-doc sphinx-documentation toolchain tooling travis-ci

Last synced: 5 months ago
JSON representation

Pre-configured template repository to integrate Sphinx-based documentation into a project with Travis CI and ReadTheDocs.org support

• Host: GitHub
• URL: https://github.com/jwflory/sphinx-docs-opinionated-quickstart
• Owner: jwflory
• License: bsd-3-clause
• Created: 2018-11-05T17:41:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T03:14:23.000Z (over 2 years ago)
• Last Synced: 2025-01-31T10:36:10.996Z (5 months ago)
• Topics: documentation, python, python3, quickstart, read-the-docs, readthedocs, sphinx, sphinx-doc, sphinx-documentation, toolchain, tooling, travis-ci
• Language: Shell
• Homepage: https://readthedocs.org/projects/sphinx-docs-opinionated-quickstart/
• Size: 60.5 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
sphinx-docs-opinionated-quickstart

==================================

[![License: BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

[![Build Status](https://travis-ci.com/jwflory/sphinx-docs-opinionated-quickstart.svg?branch=master)](https://travis-ci.com/jwflory/sphinx-docs-opinionated-quickstart)

[![Documentation Status](https://readthedocs.org/projects/sphinx-docs-opinionated-quickstart/badge/?version=latest)](https://sphinx-docs-opinionated-quickstart.readthedocs.io/en/latest/?badge=latest)

Quick-start, opinionated template repository to add [Sphinx-based documentation](http://www.sphinx-doc.org/) to an existing project

## About

This repository is a working implementation of a documentation toolchain powered by [Sphinx](http://www.sphinx-doc.org/).

Use these files to quickly set up Sphinx inside of an existing project.

For convenience, most of the special sauce is inside the `docs/` directory, so you can copy it straight into another project.

### "But I thought Sphinx had a quickstart tool already."

Yes, it does.

But I have opinions.

And I am lazy.

So, when I am starting a new project, I want to use a preferred configuration instead of starting from the ground up.

Sometimes, you may want to start from the ground up.

So try that first if you like.

But if you are like me, and want to do more writing and less configuring, make your life easier and use a common base.

This repo is all about getting you to spend more time on what deserves your time, not getting lost in configuration options. :tada:

## About reusing this repo

This repository is licensed under the [BSD 3-Clause License](https://choosealicense.com/licenses/bsd-3-clause/ "BSD 3-Clause “New” or “Revised” License").

Reuse anything you want in your own projects.

If you use this quickstart repo in a public repository, a link back here in your README is appreciated. :+1: