cl3m3nt/sphinx repository overview

docker run -it -v ${PWD}/example/mydocs:/root/docs cl3m3nt/sphinx

> Root path for the documentation [.]:
> Separate source and build directories (y/n) [n]: y
> Name prefix for templates and static dir [_]:
> Project name: Test_project
> Author name(s): Cl3m3nt
> Project version: 0.1
> Project release [0.1]:
> Project language [en]:

....

user@computer - ~/example/mydocs > tree
├── Makefile
├── build
├── make.bat
└── source
    ├── _static
    ├── _templates
    ├── conf.py
    └── index.rst

4 directories, 4 files

example/mydocs/source
├── _static
├── _templates
├── conf.py
├── index.rst
└── test.rst

user@computer - ~/example/mydocs > docker run -it -v ${PWD}/example/mydocs:/root/docs cl3m3nt/sphinx make html
Running Sphinx v1.5.5
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] test
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] test
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.

Build finished. The HTML pages are in build/html.