Tasks

• Tasks
  • Open
  • Closed

Open

• Write accompanying article on LinkedIn.
• Check fonts.
• Fix versioning.

Closed

• Include Makefile to setup project.
  • Create template Makefile.
  • Enable poetry env plugin.
  • Install project.
  • Update pre-commit hooks.
  • Install pre-commit hooks.
• Add site_url to mkdocs.yml.
• Create repo on GitHub.
• CI/CD with GitHub Actions.
• Add some more pages for in navigation.
  • Project layout in file.
  • Home in file.
  • Write some content for Home.
  • Throw in some admonitions for fancy graphics.
• Add stubgen script.
• Check serve preview for mistakes in docstrings.
• Do additional site configuration.
• Write tests.
  • Could include some more, but not really the point of the project.
• Structure code:
  • Do not only use lib/.
  • Add some more code to generate documentation from.
• Basic mkdocs Material
• mkdocstrings
• Refactor lib scripts to make use of a factory (e.g. pass command and create new func).
• Pre-commit hooks.
• MkDocstrings site configuration
• Ideally you want the following output structure for reference/:

  site/reference/
  ├── main_package/
  │   ├── constants/
  │   ├── lib/
  │   ├── mkdocs_testing/
  │   ├── scripts/
  │   └── index.html
  └── SUMMARY.html