Create your first project
Using sphinx-quickstrat
command, you can now create your first project structure and view your website.
Create your first project
To create your first project execute.
(.venv) usr1@server:~/sphinx$ sphinx-quickstart docs
This will create a directory named docs
structured as follows.
docs
├── build
├── make.bat
├── Makefile
└── source
├── conf.py
├── index.rst
├── _static
└── _templates
The configuration parameters for the generation of the html pages are specified in the file docs/source/conf.py
and the content of the index.html
page is in the docs/source/index.rst
file.
For the moment the build
folder is empty. This is the target directory for the generation.