Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Document installed Sphinx extensions, usable syntax, modifications #42

Open
14 tasks
Paebbels opened this issue Dec 18, 2016 · 0 comments
Open
14 tasks

Comments

@Paebbels
Copy link
Member

The Sphinx documentation flow was extended by several sphinx and third party extensions. These extensions should be documented along with their modifications. A comprehensive syntax guide should be assembled, to collect all syntax notations at one place instead of dozens of third party documentation websites with partially poor usage descriptions.

Extensions list:

  • Standard Sphinx extensions
    • sphinx.ext.autodoc
    • sphinx.ext.extlinks
    • sphinx.ext.intersphinx
    • sphinx.ext.inheritance_diagram
    • sphinx.ext.todo
    • sphinx.ext.graphviz
    • sphinx.ext.mathjax
    • sphinx.ext.ifconfig
    • sphinx.ext.viewcode
  • SphinxContrib extensions
    • sphinxcontrib.wavedrom
    • autoapi.sphinx
  • local extensions (patched)
    • autoprogram (derived from sphinxcontrib.autoprogram)
  • local extensions
    • DocumentMember
    • PoC

Syntax:

  • from docutils
  • from Sphinx
  • from Sphinx extensions
  • from own extensions
@Paebbels Paebbels added this to the Version 1.3 milestone Dec 18, 2016
@Paebbels Paebbels self-assigned this Dec 18, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Documentation
Issue / PullRequest
Development

No branches or pull requests

1 participant