Giter Club home page Giter Club logo

sphinxext-autox's Introduction

Sphinx-autox

A little opinionated version of autodoc and autosummary that recursively documents your modules and creates one file per class.

Usage

Add sphinxext_autox as the first entry to your extensions in conf.py:

extensions = [
    'sphinxext_autox',
    ...
]

Create a api.rst file like the following:

My API
======

.. autosummary::
   :toctree: source
   :recursive:

   mymodule1
   mymodule2

The stub files will be created/maintained in the source folder.

Critique

Unfortunately, since other files in Sphinx also try to load autodoc, this package has to replace the original files. It isn't possible to make a custom version without also having to change the rST tags.

sphinxext-autox's People

Contributors

simonbin avatar

Watchers

Tom Soru avatar Martin avatar René Speck avatar Michael Martin avatar Jens Lehmann avatar Claus Stadler avatar James Cloos avatar Dimitris Kontokostas avatar Mohamed avatar Axel Ngonga avatar Thomas Riechert avatar Ali Khalili avatar Mofeed Hassan avatar Muhammad Saleem avatar  avatar Kurt Junghanns avatar Ricardo Usbeck avatar Markus Ackermann avatar Edgard Marx avatar Ritesh Kumar Singh avatar Michael Röder avatar Kunal jha avatar AKSW docker index account avatar Matthias Wauer avatar Diego Esteves 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.