Glossary

  1. What is Sphinx?

    Sphinx is a tool that makes it easy to create documentation. It supports various output formats including html, and has powerful extensions that to help keep your API documentation up to date.

  2. What is reStructuredText?

    A plaintext markup syntax and parser. reStructuredText files use the extension .rst. Sphinx primarily parses .rst files and generates files in your target format (like html, or PDF).

  3. What is a docstring?

    A string literal specified in source code that is used to document a specific segment of code. Usually follows a specific format parsable by various tools, including Sphinx.

  4. What is PyPI?

    PyPI (pronounced Pie-‘P’-‘I’) is the Python Package Index (docs). It’s the default, global Python package mirror.


Previous: Automating versioning Next: Further reading