Changes to the package :
- now trying to offload more work into python, rather than having to configure separate ci/cd files in each repository, plus some mkdocs.yml config files, etc.
- Thus, it will try to auto generate a mkdocs.yml file with supplied information, and a provided template.
- This template is non editable, as the goal of the package is to make a simple documentation work fast.
- If tuning is needed, auto_fast_docs will not generate a mkdocs.yml file if it already exists, so you can still fine tune it as your project grows and the CI/CD will still work in the same way.
- The command line thus now excepts a bit more arguments to automatically determine this. The minimal example is :
auto_fast_docs my_repo_name --username my_cute_name --layout flat
- A "project agnostic" version for your CI/CD would be :
auto_fast_docs ${{github.event.repository.name}} --username ${{github.actor}} --layout src.
The advantage of the latter syntax (github workflow specific) is that you can copy paste it to every project without worrying to edit it per project, and it will still work.
- It now handles docs for flat or src code layouts (using the option --layout or -l. By default, layout is "flat")
- The implementation tries now to also deploy the docs directly, callin mkdocs deploy or build internally, so as little text as possible is needed in the CI/CD file.
- It also attempts at working for both github and gitlab repos, although gitlab ones havn't been tsted yet (planned soon as i use both). Another release will be made once the functionnality will have been checked and tested on both platforms in various cases (with organizations / users, gitlab subgroups, etc)
- The package name has changed as the original name (auto_doc) was too general and wasn't accepted on pypi. Thus, it is now accessible directly via pypi install. No more github url needed with pip.
- Finally the internal code has also been reworked to be more readable and better organized (classes instead of quick and dirty functions)