Rebranding Administrator Manual¶
It’s possible to create a custom version of the Administrator Manual.
Clone the documentation repository
Create a directory inside the main
administrator-manual/<lang>directory. Example for a new rebranding called NethService and available only in Italian:
Enter the directory, and create the structure:
cd nethservice mkdir _templates _static _build _themes
Copy the makefile and configuration from parent directory:
cp ../Makefile ../conf.py .
First, create a custom
index.rst with required chapters. Example:
My section ------------- .. toctree:: :maxdepth: 2 installation newchapter
To add a chapter, create new rst file inside the current directory. Example for
=========== New chapter =========== This is a new chapter.
If you wish to reuse existing chapters, create links to the parent directory. Example:
ln -s ../installation.rst installation.rst
Product name and version¶
conf.py by setting product name and version. Feel free to customize anything you need but make sure to edit at least following variables:
rst_prolog file with the macro for product name and download site. Content of
.. |product| replace:: NethService .. |download_site| replace:: http://www.nethesis.it
Choose and existing Sphinx theme or copy a new theme inside the
If you want to use a custom theme, remember to set following variables inside
html_theme_path = ['_themes'] html_theme = 'mynewshinytheme'
If you wish to add custom artworks like logo and favicon, edit these variables inside
html_static_path = ['_static'] html_logo = '_static/logo.png' html_favicon = '_static/favicon.ico