Create your own awesome maps

Even on the go

with our free apps for iPhone, iPad and Android

Get Started

Already have an account?
Log In

Copy of Sphinx talk by Mind Map: Copy of Sphinx talk
0.0 stars - reviews range from 0 to 5

Copy of Sphinx talk

Indexing

Auto generated

Index directive, Index:, single: Executive Example, single: User Guide; Execution Example

Labels

Used for cross references

_coolproj:

For more info: :ref: coolproj

TOC

Auto generated

Toc directivr

Define max depth

conf.py

Configuration file

Regular python file, Eg, inc version number

Add extensions

Sphinx needs this to understand the structure & global metadata of your project

Like settings.py

Themes

Extensions

eg,

Adds link to source code, whenever you refer to some function &c

autodoc

Rss

Not just for Python

Quick start

sphinx-QuickStart

Asks you many questions

make HTML

Documentation is required & crucial

Affects adoption

DocStrings are not documentation

Arch, usage, philosophy

An important reject reason for commits is:

Need better docs

Infra

reStructuredText

rst

Can use many characters for header levels, as long as its consistent

Simple lists & links

Admonitions, Borders & labels

Indentation like Python

But rst has no context across files

Extensible, via directives, TOC

PyGments

Used also in GitHub

Jinja2

Infra

reStructuredText

rst

Can use many characters for header levels, as long as its consistent

Simple lists & links

Admonitions, Borders & labels

Indentation like Python

But rst has no context across files

Extensible, via directives, TOC

PyGments

Used also in GitHub

Jinja2

Documentation is required & crucial

Affects adoption

DocStrings are not documentation

Arch, usage, philosophy

An important reject reason for commits is:

Need better docs

Quick start

sphinx-QuickStart <folder>

Asks you many questions

make HTML

Not just for Python

Extensions

eg,

Adds link to source code, whenever you refer to some function &c

autodoc, Documentation from DocStrings, automodule, autoclass

Rss

YouTube

Google Analytics

Sphinx Contrib

New Node

Themes

conf.py

Configuration file

Regular python file, Eg, inc version number

Add extensions

Sphinx needs this to understand the structure & global metadata of your project

Like settings.py

TOC

Auto generated

Toc directivr

Define max depth

Labels

Used for cross references

_coolproj:

For more info: :ref: coolproj

Indexing

Auto generated

Index directive, Index:, single: Executive Example, single: User Guide; Execution Example

Domains

Python domain

To label code elements, py:function:: format_exception, :param etype exception type, If you put this in DocString it will understand what you are describing, For more info see :py:func: format_exception

Many more domains

ReadTheDocs

Auto updating

All VCS & many code hosting sites

Caching

Versions

PDF generation

Search

JS

FTS

Alternate domains

awesome.readthedocs.org

Intersphinx

Cross references between projects, Soft logical links

Meir use it for Presentations

Tip

python -m http.server

Web server in current dir

python -m SimpleHttpServer