Merge pull request #87 from ncusi/documentation - docs/annotation_pro…

…cess.md

Documentation: Add docs/annotation_process.md

README.md

@@ -91,6 +91,9 @@ Each script and subcommand supports the `--help` option.
     - `diff-gather-stats timeline [OPTIONS] OUTPUT_FILE DATASETS...`:
       calculate timeline of bugs with per-bug count of different types of lines;
 
+You can find more information about the annotation process in
+_"[Annotation process](docs/annotation_process.md)"_ documentation.
+
 ### Running web app (dashboard)
 
 This package also includes web dashboard, created using the [Panel][]

TODO.md

@@ -23,9 +23,13 @@
           (in which case we are for sure in editable install mode)
     - [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][]
+      - [x] generate API documentation using [mkdocstrings][]
+          - [ ] switch from Sphinx/reST format to better supported Numpydoc format
+                with [docconvert](https://github.com/cbillingham/docconvert)
+                or [pyment](https://github.com/dadadel/pyment)
+      - [x] generate documentation for scripts using [mkdocs-typer][]
             ([typer][] is used for parsing CLI arguments)
+          - [ ] replace it with a better solution, e.g. from the next point
       - [ ] _maybe_ generate manpages from MkDocs with [mkdocs-manpage][] (at least for scripts)
       - [ ] _maybe_ include gallery of examples with [mkdocs-gallery](https://smarie.github.io/mkdocs-gallery/)
       - [ ] _maybe_ CLI demos with [Asciinema][], or one of the alternatives, like
@@ -317,6 +321,7 @@ data.
 # Other TODOs
 
 - [`notebooks/panel/TODO.md`](./notebooks/panel/TODO.md)
+- [`src/diffinsights_web/TODO.md`](./src/diffinsights_web/TODO.md)
 
 [click]: https://click.palletsprojects.com/
 [typer]: https://typer.tiangolo.com/

docs/.gitignore

@@ -0,0 +1,2 @@
+# automatically generated by mkdocstrings and mkdocs-literate-nav
+reference/