diff --git a/src/pulp_docs/data/mkdocs.yml b/src/pulp_docs/data/mkdocs.yml index c62ee2c..23e5ac9 100644 --- a/src/pulp_docs/data/mkdocs.yml +++ b/src/pulp_docs/data/mkdocs.yml @@ -1,5 +1,5 @@ site_name: Pulp Project -site_url: https://staging-docs.pulpproject.org/ +site_url: https://docs.pulpproject.org/ repo_url: https://github.com/pulp/pulpcore repo_name: pulp/pulpcore @@ -29,13 +29,13 @@ theme: primary: custom accent: black toggle: - icon: material/toggle-switch-off-outline + icon: material/toggle-switch-off-outline name: Switch to dark mode - media: "(prefers-color-scheme: dark)" - scheme: slate + scheme: slate toggle: icon: material/toggle-switch - name: Switch to light mode + name: Switch to light mode hooks: - '../mkdocs_hooks.py' plugins: @@ -51,7 +51,7 @@ plugins: - literate-nav: nav_file: _SUMMARY.md - mkdocstrings: - handlers: + handlers: python: options: show_source: false diff --git a/staging_docs/dev/reference/markdown-cheatsheet.md b/staging_docs/dev/reference/markdown-cheatsheet.md index fa034c0..4dc88c5 100644 --- a/staging_docs/dev/reference/markdown-cheatsheet.md +++ b/staging_docs/dev/reference/markdown-cheatsheet.md @@ -69,10 +69,10 @@ The basic syntax is: Ordering is enabled by `mkdocs-literate-nav` (learn more [here](https://oprypin.github.io/mkdocs-literate-nav/reference.html)). -The basic setup is having a a file in `{repo}/docs/{user}/{persona}/_SUMMARY.md`. +The basic setup is having a file in `{repo}/docs/{persona}/{doc_type}/_SUMMARY.md`. In this file you should use the following syntax: -```markdown title="pulp_rpm/docs/user/guides/_SUMMARY.md" +```markdown title="pulp_plugin/docs/user/guides/_SUMMARY.md" # Basic * [First list item](z-page.md) * [Second list item](m-page.md) @@ -87,7 +87,7 @@ In this file you should use the following syntax: # Recursive Globs * [I want this first](some-page.md) * *.md -* [This last and recurse this dir](other/) +* [This last and recurse this dir](other/) ``` ### Codeblocks @@ -111,6 +111,7 @@ Markdown syntax: serializer = mymodelserializer(data=data) serializer.is_valid(raise_exception=true) instance = serializer.create(serializer.validated_data) +print(instance) ``` ```` @@ -125,11 +126,11 @@ The codeblock can also have a title, which is useful if its a file: Markdown syntax: ```` -```bash title="script.sh" +```bash title="sample-title-here.sh" pulp file repository update --name myrepo --retained-versions 1 ``` ```` - + ### Admonitions [See mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types)