Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pedro-psb committed Dec 28, 2023
1 parent cafd486 commit 693dba1
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc

This packages is:

- A `mkdocs-macros-plugin` [pluget]() (see here).
- A repository for common doc website asset (see here)
- A centralized entrypoint for installing doc-related packages/tooling.
- A possible CLI for doc-related stuff, although nothing is implemented yet.
- A `mkdocs-macros-plugin` [pluget](https://mkdocs-macros-plugin.readthedocs.io/en/latest/pluglets/). [relevant-code]()
- A repository for common doc website asset. [relevant-code](https://github.com/pedro-psb/pulp-docs/tree/main/src/pulp_docs/docs)
- A centralized entrypoint for installing doc-related packages/tooling. (via its own requirements)
- A CLI for doc-related tasks, like serving and building. [relevant-code](https://github.com/pedro-psb/pulp-docs/blob/main/src/pulp_docs/main.py)

The idea is that each repository should install `pulp-docs` and imediatelly be able run the unified website server.
Also, this should be used for the production build.
Expand All @@ -39,5 +39,12 @@ Hopefully, this should run the fixture setup:

```bash
$ pip install -r requirements.txt
$ mkdocs serve
$ pulp-docs serve
```

For other command, see:

```bash
$ pulp-docs --help
```

0 comments on commit 693dba1

Please sign in to comment.