Skip to content
/ sphinx-template Public template

Sphinx docs template, including automated deployment workflows.

License

Notifications You must be signed in to change notification settings

Kjuly/sphinx-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sphinx-template

Sphinx docs template, including automated deployment workflows.

Structure

Default folder structure in this template:

_static/     # Host shared css, image files.
_templates/  # Host template files.

source/
    _conf.py  # Shared base config file.
    requirements.txt # Optionally, you can install extra dependencies by adding this file with libs listed.

    en/
        _conf.py  # Override config file for "en".
        conf.py   # The final generated config file for "en", which will be updated for each build process.
        ...       #   You don't need to provide it manually.

    zh-Hans/
        _conf.py
        ...
build/

Regarding _conf.py, please refer to sphinx-publisher - Share & Override Config File for details.