Unified documentation for projects
Read all my repositories, gets mkdocs metadata and build a integrated documentation.
The .gsdoc
file will be found in the root of each repository, with some metadata used to build the documentation.
doc_folder: "docs" #
enabled: true
project_title: "Name of the project"
project_description: "Description of the project"
The configuration of the tool can be read from a yaml file or from environment variables.
List of organizations (comma separated) from within will be get all repositories.
- Environment:
GSDOCS_ORGS
- Configuration:
organizations
List of user (comma separated) from within will be get all repositories.
- Environment:
GSDOCS_USERS
- Configuration:
users
organizations:
- escoteirando
users:
- guionardo