8000 Documentation · cobbler/cobbler Wiki · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Documentation

Enno G edited this page Jul 12, 2022 · 2 revisions

Documentation

We are using Sphinx and are publishing the docs to Readthedocs. The source can be found in the docs folder.

We want to try to use the following rules:

  • For first level headings should use * over and under the text.
  • For second level headings should use # under the text.
  • For third level headings should use = under the text.
  • For forth level headings should use - under the text.

Requirements

  • Sphinx
  • Sphinx-apidoc

Regenerating the code-autodoc folder

cd docs
rm code-autodoc/*
sphinx-apidoc -o code-autodoc ../cobbler
Clone this wiki locally
0