docs(source): Rename source index page to Packages

Description

Abstract

Update internals.rst template and apidoc conf to set the name of the root page of the apidoc part of the doc to “Packages”.

Motivation

When going to source/modules.html doc page, the title was “isshub”, and also in the breadcum at the top, so we had isshub > isshub, which was not clear.

We needed to change this to a more meaningful name.

Rationale

This is done by setting the –doc-project option to apidoc, and we use the same name in internals.rst.

Info

Hash

6646f12f75a5f29679ce0da7691e649245d3b044

Date

2020-09-25 23:36:22 +0200

Parents

  • style(docs): Add comments to doc custom css [e31a0e11] — 2020-09-25 23:36:21 +0200

Children

  • docs(source): Lighten source code pages [a94891ff] — 2020-09-25 23:36:45 +0200

Branches
Tags

(No tags)

Changes

docs/conf.py

Note

View last source and history

Type

Modified

Stats

+2 -0

@@ -108,6 +108,8 @@ def run_apidoc(_):
             "--force",
             "--module-first",
             "--separate",
+            "--doc-project",
+            "Packages",
             "--output-dir",
             source_path,
             output_path,

docs/internals.rst

Note

View last source and history

Type

Modified

Stats

+1 -1

@@ -6,4 +6,4 @@ IssHub internals
   :maxdepth: 2

    Git repository <git/index>
-   Python modules <source/modules>
+   Packages <source/modules>