copy and paste this google map to your website or blog!
Press copy button and paste into your blog or website.
(Please switch to 'HTML' mode when posting into your blog. Examples: WordPress Example, Blogger Example)
Sphinx — Sphinx documentation These sections cover various topics in using and extending Sphinx for various use-cases They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx
Getting started — Sphinx documentation Much of Sphinx’s power comes from the richness of its default plain-text markup format, reStructuredText, along with its significant extensibility capabilities The goal of this document is to give you a quick taste of what Sphinx is and how you might use it
Installing Sphinx — Sphinx documentation You may install a global version of Sphinx into your system using OS-specific package managers However, be aware that this is less flexible and you may run into compatibility issues if you want to work across different projects
reStructuredText Primer — Sphinx documentation reStructuredText is the default plaintext markup language used by Sphinx This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to provide authors with enough information to author documents productively
Directives — Sphinx documentation Sphinx knows the relative order of the documents intro, strings and so forth, and it knows that they are children of the shown document, the library index From this information it generates “next chapter”, “previous chapter” and “parent chapter” links
Automatic documentation generation from code - Sphinx doc Sphinx provides yet another level of automation: the autosummary extension The autosummary directive generates documents that contain all the necessary autodoc directives
Configuration — Sphinx documentation This is useful to copy files that Sphinx doesn’t copy automatically, or to overwrite Sphinx LaTeX support files with custom versions Image files that are referenced in source files (e g via image::) are copied automatically and should not be listed there
Getting started — Sphinx documentation A Python script holding the configuration of the Sphinx project It contains the project name and release you specified to sphinx-quickstart, as well as some extra configuration keys
First steps to document your project using Sphinx Sphinx supports a variety of formats apart from HTML, including PDF, EPUB, and more For example, to build your documentation in EPUB format, run this command from the docs directory: