GithubHelp home page GithubHelp logo

Comments (4)

knipknap avatar knipknap commented on July 21, 2024

A Sphinx based generator is now in master, and the current documentation from the Wiki is also ported / checked in.
TODOs:

  • Port existing epydoc markup to Sphinx
  • Pull the API docs into the documentation
  • Publish the result
  • Kill the wiki based config

from spiffworkflow.

knipknap avatar knipknap commented on July 21, 2024

Another TODO: Pull the descriptions of task states out of the docstring of Task / merge with the existing tutorial-like docs.

from spiffworkflow.

knipknap avatar knipknap commented on July 21, 2024

Mostly done: Existing API docs are now ported to Sphinx syntax, except for cross-references (e.g. L{foo.bar}). Not sure how this is done in autodoc. Once I figure this out, I'm too lazy to type this again into C9:

/usr/bin/find . -name "*.py" | xargs sed -i 's/B{\([^}]*\)}/*\1*/g'

from spiffworkflow.

knipknap avatar knipknap commented on July 21, 2024

Sphinx-based documentation is now complete and published on RTD, including API docs.

from spiffworkflow.

Related Issues (20)

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.