inmanta / inmanta-sphinx

Sphinx domains for Inmanta docs
0 stars 0 forks source link

Issue/2026 include readme md in module docs #70

Closed Hugo-Inmanta closed 2 months ago

Hugo-Inmanta commented 3 months ago

Description

Part of https://github.com/inmanta/irt/issues/2026

closes https://github.com/inmanta/inmanta-sphinx/issues/72 closes https://github.com/inmanta/irt/issues/2026

Current PR:

Core PR https://github.com/inmanta/inmanta-core/pull/7861

IRT PR https://github.com/inmanta/irt/pull/2113

Tested locally with:

mkvirtualenv docs -p 3.11
git clone git@code.inmanta.com:solutions/modules/vcenter.git
git clone git@github.com:inmanta/inmanta-core.git --branch issue/2026-include-readme-md-in-module-docs
git clone git@github.com:inmanta/inmanta-sphinx.git --branch issue/2026-include-readme-md-in-module-docs
pip install inmanta-module-std -r inmanta-core/requirements.dev.txt  -e inmanta-core -e inmanta-sphinx

mkdir inmanta-core/docs/reference/modules
python -m sphinxcontrib.inmanta.api generate-api-doc-v2 --module_repo $(pwd) --module-name vcenter  --out-dir inmanta-core/docs/reference/modules/

cd inmanta-core/docs
make html

Note to self, merge this first then core and irt (they require >= 1.11.0)

Self Check:

Strike through any lines that are not applicable (~~line~~) then check the box