Commit graph

12 commits

Author SHA1 Message Date
c0b2ac4fec
Improve API documentation about typing
This also removes the redundant type annotations from the API example.
I think they make it harder to understand.
2024-11-25 13:42:27 -06:00
460b3921be
doc API: add note about experimental code 2024-10-30 14:12:53 -05:00
b6b7c181ca
lint doc API: use semantic line breaks 2024-10-30 14:12:53 -05:00
1df6911531
doc API: remove outdated note about beta status 2024-10-30 14:12:53 -05:00
d7be60e74e
doc API: clarify docstring references 2024-08-27 23:17:12 -05:00
fc5100f781
doc: remove broken reference 2024-03-18 02:08:11 +00:00
ef657fa021
doc: revamp and cleanup
- Replace nox docgen session with a mkdocs-gen-file script that imports
  helper code from releaserr
- Perform light proofreading
- Enable smarty markdown extension for proper unicode quotes and dashes
- Use more consistent scdoc formatting
2024-02-09 05:36:12 +00:00
5321e1135c
docs: fix mkdocs warnings 2023-10-23 01:46:03 +00:00
67d948b90f
docs/api/Summary.md: add dnf and libdnf5 intersphinx links 2023-09-30 04:44:57 +00:00
62627f8acb
doc: add sig_policy.py to API examples 2023-04-11 14:33:23 +00:00
6b6eaa4bfc
doc: make misc. clarifications 2023-04-02 13:38:43 -05:00
bc1e61b864
create a mkdocs docsite
Create a docsite with rendered manpages, changelogs, and Python API
documentation using mkdocs and mkdocstrings. Add a doc extra in
pyproject.toml and a mkdocs nox target. Reformat NEWS.md to fit in the
docsite.
2023-03-19 17:43:56 -05:00
Renamed from doc/API.md (Browse further)