Skip to content

Commit

Permalink
TODO.md: Mark adding docs/ directory as being done
Browse files Browse the repository at this point in the history
It is not yet complete, but it is there.  Documentation is published,
with Gitub Actions, to GitHub Pages.
  • Loading branch information
jnareb committed Dec 19, 2024
1 parent c3eab5a commit 0037353
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
- [ ] use `packaging.version.Version` (as `key` function for sorting)
to find cases where `__version__` is newer than installed version
(in which case we are for sure in editable install mode)
- [ ] add `docs/` directory (for man pages, and maybe API documentation)
- [ ] use [MkDocs][] or [Material for MkDocs][mkdocs-material] for general documentation
- [x] add `docs/` directory (for man pages, and maybe API documentation)
- [x] use [MkDocs][] or [Material for MkDocs][mkdocs-material] for general documentation
- [ ] generate API documentation using [mkdocstrings][]
- [ ] generate documentation for scripts using [mkdocs-typer][]
([typer][] is used for parsing CLI arguments)
Expand Down

0 comments on commit 0037353

Please sign in to comment.