$ cd doc/
$ sphinx-quickstart --ext-autodoc --ext-doctest --ext-mathjax --ext-viewcode
Welcome to the Sphinx 3.1.2 quickstart utility
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets
Selected root path: .
You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: y
The project name will occur in several places in the built documentation.
> Project name: leetcode practice
> Author name(s): Louis Liu
> Project release []: 1.0
If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.
For a list of supported codes, see
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
> Project language [en]:
Creating file /Users/shi-rongliu/Documents/GitHub/python_practice/Sphinx-Python-Practice/source/conf.py.
Creating file /Users/shi-rongliu/Documents/GitHub/python_practice/Sphinx-Python-Practice/source/index.rst.
Creating file /Users/shi-rongliu/Documents/GitHub/python_practice/Sphinx-Python-Practice/Makefile.
Creating file /Users/shi-rongliu/Documents/GitHub/python_practice/Sphinx-Python-Practice/make.bat.
Finished: An initial directory structure has been created.
You should now populate your master file /Users/shi-rongliu/Documents/GitHub/python_practice/Sphinx-Python-Practice/source/index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.
$ cd doc/
$ make clean
$ make html
$ cd doc/
$ make clean
$ make latexpdf
$ make doctest
Running Sphinx v3.1.2
WARNING: while setting up extension sphinx.addnodes: node class 'meta' is already registered, its visitors will be overridden
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [doctest]: targets for 3 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
running tests...
Doctest summary
===============
0 tests
0 failures in tests
0 failures in setup code
0 failures in cleanup code
build succeeded, 1 warning.
Testing of doctests in the sources finished, look at the results in build/doctest/output.txt.
$ cd doc/build/html/
$ python -m http.server
Serving HTTP on :: port 8000 (http://[::]:8000/) ...
We could then view the documentation in the web browser at http://[::]:8000/.
$ make help
Sphinx v3.1.2
Please use `make target' where target is one of
html to make standalone HTML files
dirhtml to make HTML files named index.html in directories
singlehtml to make a single large HTML file
pickle to make pickle files
json to make JSON files
htmlhelp to make HTML files and an HTML help project
qthelp to make HTML files and a qthelp project
devhelp to make HTML files and a Devhelp project
epub to make an epub
latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
latexpdf to make LaTeX and PDF files (default pdflatex)
latexpdfja to make LaTeX files and run them through platex/dvipdfmx
text to make text files
man to make manual pages
texinfo to make Texinfo files
info to make Texinfo files and run them through makeinfo
gettext to make PO message catalogs
changes to make an overview of all changed/added/deprecated items
xml to make Docutils-native XML files
pseudoxml to make pseudoxml-XML files for display purposes
linkcheck to check all external links for integrity
doctest to run all doctests embedded in the documentation (if enabled)
coverage to run coverage check of the documentation (if enabled)