The installation is done in the
ScribeEnv virtual environment.
Make sure to execute the following command:
The shell prompt should then start with
(ScribeEnv) meaning that
you are working in the proper virtual environment.
To try the installation of Sphinx type the following command and press Ctrl-C to exit from the program:
Examples. The best way to learn rst is probably to look at the source of existing rst texts. For instance on ReadTheDocs the documentation usually include a link
View Codeon the top-left corner of each page.
Cheat Sheets Here is a list of cheat sheets ordered approximatively by size.
Nice pages. Some interesting pages from Sphinx documentation:
If you have already some knowledge about markdown you may be interested by Markdown vs. rst comparison.
sphinx-googlemaps allows to embed maps using Google Maps.
sphinx-libreoffice allows to embed libreoffice images.
images enables thumbnails, fancybox, group of images, captions, tooltip.
css3image provides an enhanced image directive with additional CSS properties.
sphinx-sadisplay renders SqlALchemy models with PlantUML diagrams or GraphViz directed graphs.
schema2rst generates reST doc from database schema. Works with mysql, mysql+pymysql, postgresql.
sqltable allows to embed SQL statements in source documents and produce tabular output.
Exceltable adds support for including spreadsheets, or part of them, into Sphinx document
Rusty is a collection of extensions:
|Creates table from selected part of the Excel|
|Extends the standard include directive by converting the given shell script|
|rusty.regxlist:||Creates bullet list based on regular expression rule. Similar to rolelist directive.|
|rusty.rolelist:||Creates the bullet list from all the entries of the selected role, with some additonal ways to custom the output.|
doctest allows to add test snippets in the documentation in a natural way. It works by collecting specially-marked up code blocks and running them as doctest tests.
Within one document, test code is partitioned in groups, where each group consists of: * zero or more setup code blocks (e.g. importing the module to test) * one or more test blocks
domaintools provides a tool for easy sphinx domain creation.
jinjadomain provides a Sphinx domain for describing jinja templates.
phpautodoc enables to embed PHPDocs to sphinx document.
See also sphinx-php and _phpdomain.
httpdomain provides a Sphinx domain for describing RESTful HTTP APIs.
autoanysrc insert reST docs from files to target documentation project without auto generation definitions and signatures.
autoprogram provides an automated way to document CLI programs. It scans argparse.ArgumentParser object, and then expands it into a set of .. program:: and .. option:: directives.
autorun execute the code from a runblock directive and attach the output of the execution to the document.
programoutput inserts the output of arbitrary commands into documents.
jsoncall adds a simple button to perform test calls to JSON based apis making also possible to change parameters values through a set of input fields.
Releases is a Sphinx extension designed to help you keep a source control friendly, merge friendly changelog file & turn it into useful, human readable HTML output. The source format (kept in your Sphinx tree as changelog.rst) is a stream-like timeline that plays well with source control & only requires one entry per change (even for changes that exist in multiple release lines)
graphvizinclude enables graphviz generation of external dot files.
Error message when installing pillow on ubuntu.
sphinx-sdedit allows to embed seqence diagrams generated with _sdedit.
Tut is a tool that helps you write tutorial style documentation where sections build on one another, and include code examples along the way.
sphinxcontrib-spelling is a spelling checker for Sphinx. It uses PyEnchant to produce a report showing misspelled words.
classy-code provides drop-in replacements for Sphinx’ code-block and literalinclude directives. In addition to specifying emphasize-lines, you can specify arbitrary classes to add on a per-line basis.
getthecode adds a new directive getthecode which is equivalent to the literalinclude directive, but adds in front of the code block an header with the file name and an icon to download the file.
viewcode looks at your Python object descriptions (.. class::, .. function:: etc.) and tries find the source files where the objects are contained. When found, a separate HTML page will be output for each module with a highlighted version of the source code, and a link will be added to all object descriptions that leads to the source code of the described object. A link back from the source to the description will also be inserted.
traceables defines traceable items and relationships between them in documentation generated by Sphinx. It also offers visualization of the traceables in various forms, such as relationship graphs.
traceability adds directives and roles that serve to identify and relate portions of Sphinx documents and create lists and traceability matrices based on them.
requirements Allows declaring requirement specs wherever in the documentation (for instance, in docstrings of UnitTest.test_* methods) and displaying them as a single list.