===================================================== Welcome to Cookiecutter Python Package documentation! ===================================================== .. every doc has a double === title .. include:: ../README.rst .. toctree:: :maxdepth: 2 :caption: Contents: contents/10_introduction contents/20_why_this_package contents/30_usage/index contents/33_refs/api/modules/modules_api contents/35_development/index .. contents/40_modules should dedicate itself to ALL "Reference" Type (see Diataxis) of Documentation content We dedicate a Top-level Section (ie in side navigatoin), with name Reference(s) (Guides) to all such content. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. Reminders on how to be consistent accross sectoining and their semantics ======== DocTitle ======== ======== -------- ~~~~~~~~ """""""" .. _header1: The defines a 'header label'. It can be used for cross-referencing to this section, with below directive: :ref:`header1` Header 1 ======== Header 1.1 ---------- Header 1.1.1 ~~~~~~~~~~~~ Header 1.1.1.1 """"""""""""""