primary_domain = 'cpp' # Tell sphinx what the pygments highlight language should be.
# The `extensions` list should already be in here from `sphinx-quickstart` extensions = # Setup the breathe extension breathe_projects = # Tell sphinx what the primary language being documented is. Just to demonstrate that using those configuration values could also be accomplished
Html_css_files and html_js_files, this example is _static/super_hack.js file has become easier via the Noting that in recent times, adding a custom _static/custom.css file or Instance so any method there is fair game. Point is that app is going to be a Sphinx Your conf.py file, if you add a magic def setup(app): method then you will beĪble to do all sorts of things like adding custom “roles” or “directives”. One of my most favorite, but not very well documented, features of conf.py is thatĮffectively every sphinx project is a Sphinx Extension of sorts. These – directives – are whatĮxhale needs to do its thing. Write in markdown, but need to call “directives”. Source_suffix value in conf.py to include markdown, if that is However, it needs to be enabled in your project Own custom (and even programmatically defined) substitutions to make life easy. The docs on rst_epilog – that makes it so that you could inject your Taking a scroll through to see what kind of customization can be done! For example, see There are a lot of options available to you, it’s worth Where do Magic Variables Come From? Īny variable listed on Sphinx Configurations Module can be added Not immediately obvious until you start working. Worth pointing out a couple of important usage features of the conf.py file that are The conf.py file generated does not have a whole lot left in it anymore, but it’s There is also the official Sphinx Quickstart Guide with more information on buildersĪnd whatnot. Use the Makefile to build the docs, like so: make builder where "builder" is one of the supported builders, e.g. You should now populate your master file /path/to/docs/index.rst and create other documentation source files. Finished: An initial directory structure has been created. > Project language : Creating file /path/to/docs/conf.py. Sphinx will then translate text that it generates into that language. > Project name: Super Project > Author name(s): Myself ThePerson, Robotic Armistice > Project release : 0.1.0 If the documents are to be written in a language other than English, you can select a language here by its language code. The project name will occur in several places in the built documentation. Our project so that sphinx can populate as much as possible of our conf.py for us: See also:įinishing the sphinx-quickstart command output, we enter the relevant metadata about Templates_path which defaults to _templates. Where you would store custom jinja2 templates to override settings in your chosen
Where you would track things like a custom.css stylesheet, any logo icons,Ī custom.js javascript file, etc. _static and _templates directories for you. The only other thing worth pointing out here is that by default sphinx reates the gitignore or related version control ignore file. In either case, you will definitely want to add docs/_build or docs/build to In the y case it will be in docs/build/html. Make html, then in the n case a folder docs/_build/html will be created, and The build artfiacts go here section is to just explain that if you do Specified in any configuration variables are relative to wherever conf.py lives. The main thing to understand is that where Exhale is concerned, all relative paths
0 kommentar(er)
