From ebadefc515f4ea9514f3a6f497c1a5891f705b14 Mon Sep 17 00:00:00 2001 From: Pedro Brochado Date: Thu, 11 Jan 2024 16:32:37 -0300 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 36b149c..7310e0c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ -# pulp-docs: Unified multirepo documenation +# pulp-docs: Unified multirepo documentation -- [pulp-docs: Unified multirepo documenation](#pulp-docs-unified-multirepo-documenation) - - [Overview](#overview) - - [How it works](#how-it-works) - - [Runninng Locally](#runninng-locally) +- [Overview](#overview) +- [How it works](#how-it-works) +- [Runninng Locally](#runninng-locally) Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc. @@ -25,7 +24,11 @@ Also, this should be used for the production build. Through a `mkdocs-macro-plugin` hook (called in early stages of mkdocs processing), we inject the following steps: -1. Download all source code needed for the build (either copying from local filesystem or downloading from GH) +1. Read `repolist.yml` packaged with `pulp-docs` to know which repos/urls to use +1. Download/Move all source code required to dir under `tempfile.gettempdir()` + - Uses `../{repo}` if available OR + - Uses existing cached `{tmpdir}/{repo}` if available OR + - Downloads from github 1. Configure `mkdocstrings` to find each repo codebase 1. Configure `mkdocs` navigation by leveraging our `/docs` content organization structure @@ -33,10 +36,6 @@ And thats it, the magic is done. ## Runninng Locally -Fixtures are fake respositories with code and docs. They are located in `tests/fixtures/`. - -Hopefully, this should run the fixture setup: - ```bash $ pip install -r requirements.txt $ pulp-docs serve