Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to build just one file with Sphinx

For a fast preview, I want to build only one file and not all the project. It is possible with sphinx ?

Recently I do something like :

sphinx-build -b html documentation/ doc_html
like image 968
zedouard Avatar asked Aug 16 '12 16:08

zedouard


People also ask

What is Sphinx Makefile?

Sphinx is what is called a documentation generator. This means that it takes a bunch of source files in plain text, and generates a bunch of other awesome things, mainly HTML. For our use case you can think of it as a program that takes in plain text files in reStructuredText format, and outputs HTML.

What is a conf py file?

The configuration directory must contain a file named conf.py . This file (containing Python code) is called the “build configuration file” and contains (almost) all configuration needed to customize Sphinx input and output behavior. An optional file docutils.


1 Answers

Sphinx already uses incremental build by writing output files only for new and changed source files. But before that, full build is needed because Sphinx needs to know where the internal links are pointing and where they are referenced from.

like image 56
plaes Avatar answered Oct 07 '22 20:10

plaes