Build your first project

To generate the html pages with the pre-configured parameters and content you can use the sphinx-build executable.

To be able to execute it, first activate the Python virtual environement :

usr1@server:~/sphinx$ source .venv/bin/activate

Then execute the following :

(.venv) usr1@server:~/sphinx$ sphinx-build -M html docs/source/ docs/build/

This will result in the generation of the html website under the build/html folder that looks like this.

docs
├── build
    ├── doctrees
    ├── html
        ├── _sources
        ├── _static
            ├── css
            ├── js
            ├── scripts
            ├── styles
            alabaster.css
            .
            .
            doctools.js
            .
            .
        .buildinfo
        index.html
        objects.inv
        searchindex.js
├── make.bat
├── Makefile
└── source
    ├── conf.py
    ├── index.rst
    ├── _static
    └── _templates

The folder html/static contains *.css and *.js files that are used for the generated web site. The index.html file is generated under html/ folder.