Add the Spinx starter pack for RTD site (ISD-2738)

[erinecon]

Overview

Add a docs folder containing Canonical's Sphinx starter pack.

Rationale

Needed for a 12-factor RTD site to hold the developer documentation.

Added the navigational structure for tutorials, how-to guides, and explanation. This is because docs already exist or are planned to be produced during this cycle.

The contributing document in the how-to folder still contains TODO items that either need to be handled in a follow-up PR or could be handled in this PR.

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Managing Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated
• The PR is tagged with appropriate label (urgent, trivial, complex)
• The changelog has been updated

There are no Charmhub docs for this project (in fact, the checklist may need to be updated to include RTD as a place where docs can be updated).

[github-actions]

license-eye has checked 230 files.

Valid	Invalid	Ignored	Fixed
129	18	83	0

Click to see the invalid file list

• .wokeignore
• docs/.readthedocs.yaml
• docs/.sphinx/_static/css/pdf.css
• docs/.sphinx/_templates/header.html
• docs/.sphinx/get_vale_conf.py
• docs/.sphinx/metrics/build_metrics.sh
• docs/.sphinx/metrics/source_metrics.sh
• docs/.sphinx/spellingcheck.yaml
• docs/.wokeignore
• docs/Makefile
• docs/Makefile.sp
• docs/conf.py
• docs/doc-cheat-sheet.rst
• docs/explanation/index.rst
• docs/how-to/contributing.rst
• docs/how-to/index.rst
• docs/index.rst
• docs/tutorial/index.rst

Use this command to fix any missing license headers

```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

[weiiwang01]

The Vale style check failure was caused by a missing dependency and should be fixed in the following PR.

canonical/operator-workflows#494

[github-actions]

Test coverage for c116491

Name                                          Stmts   Miss Branch BrPart  Cover   Missing
-----------------------------------------------------------------------------------------
src/paas_app_charmer/__init__.py                  2      0      0      0   100%
src/paas_app_charmer/django/__init__.py           2      0      0      0   100%
src/paas_app_charmer/django/charm.py              2      0      0      0   100%
src/paas_app_charmer/fastapi/__init__.py          2      0      0      0   100%
src/paas_app_charmer/fastapi/charm.py             2      0      0      0   100%
src/paas_app_charmer/flask/__init__.py            2      0      0      0   100%
src/paas_app_charmer/flask/charm.py               2      0      0      0   100%
src/paas_app_charmer/go/__init__.py               2      0      0      0   100%
src/paas_app_charmer/go/charm.py                  2      0      0      0   100%
src/paas_charm/__init__.py                       32     17      0      0    47%   13-14, 19-20, 26-27, 33-37, 43-44, 50-51, 57-58
src/paas_charm/_gunicorn/__init__.py              0      0      0      0   100%
src/paas_charm/_gunicorn/charm.py                15      0      0      0   100%
src/paas_charm/_gunicorn/webserver.py            83      4     14      1    95%   175, 187-193
src/paas_charm/_gunicorn/workload_config.py       8      0      0      0   100%
src/paas_charm/_gunicorn/wsgi_app.py             16      0      0      0   100%
src/paas_charm/app.py                           157      0     54      3    99%   110->exit, 167->173, 341->343
src/paas_charm/charm.py                         242     26     54      3    90%   34-35, 42-43, 205, 215-216, 218-219, 248-252, 316-318, 379-380, 385, 390, 395, 405, 410, 415, 420, 425, 450
src/paas_charm/charm_state.py                   107      2     12      2    97%   187, 277
src/paas_charm/charm_utils.py                    23      0      0      0   100%
src/paas_charm/database_migration.py             35      0      2      0   100%
src/paas_charm/databases.py                      25      2      6      1    90%   89-90
src/paas_charm/django/__init__.py                 2      0      0      0   100%
src/paas_charm/django/charm.py                   50      4      8      2    90%   49, 124, 139-140
src/paas_charm/exceptions.py                      5      0      0      0   100%
src/paas_charm/fastapi/__init__.py                2      0      0      0   100%
src/paas_charm/fastapi/charm.py                  31      0      0      0   100%
src/paas_charm/flask/__init__.py                  2      0      0      0   100%
src/paas_charm/flask/charm.py                    26      0      0      0   100%
src/paas_charm/framework.py                      23      4     12      2    77%   36, 49-51
src/paas_charm/go/__init__.py                     2      0      0      0   100%
src/paas_charm/go/charm.py                       28      0      0      0   100%
src/paas_charm/observability.py                  24      3      4      1    86%   42->46, 73-77
src/paas_charm/rabbitmq.py                       78      2     22      5    93%   117->exit, 122->exit, 157->exit, 159-160, 181->175
src/paas_charm/secret_storage.py                 50      2     14      4    91%   55->54, 56->58, 86, 105
src/paas_charm/utils.py                          44      7     14      5    79%   34, 36, 56-57, 75, 79, 104
-----------------------------------------------------------------------------------------
TOTAL                                          1128     73    216     29    92%

Static code analysis report

Run started:2024-12-11 18:26:28.912619

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2380
  Total lines skipped (#nosec): 1
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 2

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):