sphinx-quickstart

Sinopse

sphinx-quickstart

Descrição

sphinx-quickstart é uma ferramenta que faz questões sobre seu projeto e então gera um diretório completo e um arquivo ou comando Make para ser usado com sphinx-build(1).

Opções

-q, --quiet

Modo silencioso que pula o assistente interativo para especificar opções. Esta opção requer as opções -p, -a e -v.

-h, --help, --version

Exibir sumário uso ou versão Sphinx.

Opções Estrutura

--sep

Se especificado, separa diretório fonte e de construção.

--no-sep

Se especificado, crie um diretório de construção sob o diretório fonte.

--dot=DOT

Dentro do diretório raiz, mais dois outros diretórios serão criados; “_templates” para modelos HTML personalizados e “_static” para folhas de estilo (arquivos .css) e outros tipos estátivos de arquivos. Pode ser usado outros prefixos como (“.”) para substituir o underscore.

Opções Projeto Básico

-p PROJECT, --project=PROJECT

Nome do projeto será utilizado. (ver project).

-a AUTHOR, --author=AUTHOR

Nome autor. (ver copyright).

-v VERSION

Versão do projeto. (ver version).

-r RELEASE, --release=RELEASE

Release do projeto. (ver release).

-l LANGUAGE, --language=LANGUAGE

Idioma do Documento. (ver language).

--suffix=SUFFIX

Sufixo arquivos fonte. (ver source_suffix).

--master=MASTER

Nome documento mestre. (ver root_doc).

Opções Extensões

--ext-autodoc

Habilitar extensão sphinx.ext.autodoc.

--ext-doctest

Habilitar extensão sphinx.ext.doctest.

--ext-intersphinx

Habilitar extensão sphinx.ext.intersphinx

--ext-todo

Habilitar extensão sphinx.ext.todo

--ext-coverage

Habilitar extensão sphinx.ext.coverage.

--ext-imgmath

Habilitar extensão sphinx.ext.imgmath.

--ext-mathjax

Habilitar extensão sphinx.ext.mathjax.

--ext-ifconfig

Habilitar extensão sphinx.ext.ifconfig.

--ext-viewcode

Habilitar extensão sphinx.ext.viewcode.

--ext-githubpages

Ative a extensão sphinx.ext.githubpages.

--extensions=EXTENSIONS

Ativar extensões arbitrárias.

Opções Criação Makefile e Batchfile

--use-make-mode (-m), --no-use-make-mode (-M)

Makefile/make.bat usa (ou não usa) make-mode. Padrão é use, o qual gera maior concisão em Makefile/make.bat.

Alterado na versão 1.5: make-mode é padrão.

Alterado na versão 7.3: O suporte para desativar o modo make será removido no Sphinx 8.

Removido na versão 8.0: A opção --no-use-make-mode. A --use-make-mode agora não tem efeito.

--makefile, --no-makefile

Criar (ou não criar) makefile

--batchfile, --no-batchfile

Criar (ou não criar) batchfile

Projeto Modelo

Adicionado na versão 1.5: Opções de projeto modelo para sphinx-quickstart

-t, --templatedir=TEMPLATEDIR

Diretório modelo para arquivos modelo. Pode ser modificado os arquivos modelo do projeto sphinx gerados por quickstart. Seguindo modelo arquivos Jinja2 é possível:

  • root_doc.rst.jinja

  • conf.py.jinja

  • Makefile.jinja

  • Makefile.new.jinja

  • make.bat.jinja

  • make.bat.new.jinja

Para detalhes, favor consultar sistema de arquivo modelos que o Sphinx fornece. (sphinx/templates/quickstart)

-d NAME=VALUE

Definir variável no modelo

Ver também

sphinx-build(1)