Index

Symbols

--host serve command line option --mode build command line option publish command line option --name build command line option

--open serve command line option --port serve command line option --repo publish command line option --repository publish command line option

B

BASE_PATH build command line option init command line option publish command line option serve command line option test command line option

build command line option --mode --name BASE_PATH build() (sphinx_ape.build.DocumentationBuilder method) BuildError BuildMode (class in sphinx_ape.build)

C

clean() (sphinx_ape.build.DocumentationBuilder method)

D

doctest_folder (sphinx_ape.testing.DocumentationTester property) doctest_output_file (sphinx_ape.testing.DocumentationTester property)

DocumentationBuilder (class in sphinx_ape.build) DocumentationTester (class in sphinx_ape.testing)

I

init command line option BASE_PATH

L

LATEST (sphinx_ape.build.BuildMode attribute)

M

MERGE_TO_MAIN (sphinx_ape.build.BuildMode attribute) module sphinx_ape.build sphinx_ape.exceptions sphinx_ape.testing

P

publish command line option --mode --repo --repository BASE_PATH

publish() (sphinx_ape.build.DocumentationBuilder method) PublishError

R

RELEASE (sphinx_ape.build.BuildMode attribute)

S

serve command line option --host --open --port BASE_PATH sphinx_ape.build module

sphinx_ape.exceptions module sphinx_ape.testing module SphinxApeException

T

test command line option BASE_PATH

test() (sphinx_ape.testing.DocumentationTester method) TestError