Primeiros passos
Guias de usuário
sphinx.ext.autodoc - Inclui documentação das docstringssphinx.ext.autosectionlabel – Permite referenciar seção usando seu títulosphinx.ext.autosummary – Gera resumos autodocsphinx.ext.coverage – Coleta estatísticas docsphinx.ext.doctest – Trechos de teste na documentaçãosphinx.ext.duration – Mede durações de processamento Sphinxsphinx.ext.extlinks – Marcação para encurtar links externossphinx.ext.githubpages – Publicar docs HTML em páginas GitHubsphinx.ext.graphviz – Adiciona Gráficos Graphvizsphinx.ext.ifconfig – Inclui conteúdo baseado em configuraçãosphinx.ext.imgconverter – Um conversor de imagem de referência usando o Imagemagicksphinx.ext.inheritance_diagram – Inclui diagramas de herançasphinx.ext.intersphinx – Link para documentação outros projetossphinx.ext.linkcode - Adiciona links externos ao código-fonteSphinxsphinx.ext.napoleon – Suporte para doctrings de estilo NumPy e Googlesphinx.ext.todo – Suporta itens todosphinx.ext.viewcode – Adiciona links ao código destacadoComunidade
Referência
sphinx.ext.autodoc - Inclui documentação das docstringssphinx.ext.autosectionlabel – Permite referenciar seção usando seu títulosphinx.ext.autosummary – Gera resumos autodocsphinx.ext.coverage – Coleta estatísticas docsphinx.ext.doctest – Trechos de teste na documentaçãosphinx.ext.duration – Mede durações de processamento Sphinxsphinx.ext.extlinks – Marcação para encurtar links externossphinx.ext.githubpages – Publicar docs HTML em páginas GitHubsphinx.ext.graphviz – Adiciona Gráficos Graphvizsphinx.ext.ifconfig – Inclui conteúdo baseado em configuraçãosphinx.ext.imgconverter – Um conversor de imagem de referência usando o Imagemagicksphinx.ext.inheritance_diagram – Inclui diagramas de herançasphinx.ext.intersphinx – Link para documentação outros projetossphinx.ext.linkcode - Adiciona links externos ao código-fonteSphinxsphinx.ext.napoleon – Suporte para doctrings de estilo NumPy e Googlesphinx.ext.todo – Suporta itens todosphinx.ext.viewcode – Adiciona links ao código destacadosphinx.ext.githubpages – Publicar docs HTML em páginas GitHub¶Adicionado na versão 1.4.
Alterado na versão 2.0: Suporta arquivo CNAME
Essa extenção cria arquivo .nojekyll nos diretórios HTML para publicar documentos Páginas GitHub.
Ele também cria um arquivo CNAME para domínios customizados quando definido html_baseurl.