Giter VIP home page Giter VIP logo

awesome-sphinxdoc's Introduction

Awesome Sphinx (Python Documentation Generator)

A curated list of awesome extra libraries, software and resources for Sphinx (Python Documentation Generator). Inspired by awesome-sqlalchemy. (See also other awesome lists!)

Licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Your contributions are welcome.

Table of Contents

Articles & Presentations

Documenting Your Project With Sphinx

Exercises for the Sphinx Tutorial that Brandon Rhodes often gives at PyCon.

Documentation

Extensions

sphinx-git

git Changelog for Sphinx.

sphinxcontrib-autoprogram

Provides an automated way to document CLI programs.

sphinxcontrib-blockdiag

Sphinx extension for embedding blockdiag diagrams.

sphinxcontrib-httpdomain

Provides a Sphinx domain for describing RESTful HTTP APIs.

Themes

flask-sphinx-themes

Sphinx Themes for Flask related projects and Flask itself.

krTheme Sphinx Style

Sphinx theme Kenneth Reitz use for most projects e.g. Requests.

sphinx_rtd_theme

Sphinx theme for readthedocs.org.

sphinxjp.themes.basicstrap

Sphinx theme built with responsive Bootstrap.

Tools

Okydoky

Automated docs builder using Sphinx/GitHub/Distribute for private use.

sphinx-autobuild

Watch a Sphinx directory and rebuild the documentation when a change is detected.

Sphinx to GitHub

Script to prepare Sphinx html output for GitHub Pages.

ghp-import

Script to overwrite a gh-pages/master branch with a .nojekyll file for GitHub Pages.

awesome-sphinxdoc's People

Contributors

westurner avatar yoloseem avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.