Docker Commands

Using sphinx-docker-images, you can efficiently generate, build, and compile documentation directly within Docker containers. This approach integrates documentation processes seamlessly into both development and production workflows.

$ docker pull dunderlab/docs
$ docker pull sphinxdoc/sphinx-latexpdf

quickstart

The enhanced sphinx-quickstart command offers a more efficient and user-friendly setup process. It streamlines the initial configuration, accommodating both novice and experienced users for rapid documentation deployment.

$ dunderlab_docs quickstart '--project "<project name>" --author="<author>" --extensions nbsphinx,dunderlab.docs --no-batchfile --quiet --sep'

apidoc

The refined sphinx-apidoc command simplifies its functionality, requiring only the module name as input. This makes the documentation generation process more intuitive and faster, streamlining workflows for developers and documentarians.

$ dunderlab_docs apidoc <module_name>

build

The build command, similar to sphinx-build, requires specifying the output format, such as HTML, EPUB, or LaTeX PDF, along with the module name. This flexibility is crucial for generating documentation in various formats to meet different needs.

$ dunderlab_docs build <html,epub,latexpdf> <module_name>

server

The server command launches HTML documentation in a web browser, simplifying the review and sharing process. It allows immediate viewing of rendered HTML pages in the browser, ensuring quick assessment of the documentation’s visual and functional aspects.

$ dunderlab_docs server <port>