https://github.com/clearcodehq/pyziomkidoctools
Docker with documentation tools used by Pyziomki team at ClearcodeHQ
https://github.com/clearcodehq/pyziomkidoctools
Last synced: 3 months ago
JSON representation
Docker with documentation tools used by Pyziomki team at ClearcodeHQ
- Host: GitHub
- URL: https://github.com/clearcodehq/pyziomkidoctools
- Owner: ClearcodeHQ
- Created: 2021-08-25T15:34:55.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T07:21:37.000Z (about 2 years ago)
- Last Synced: 2024-04-16T01:28:02.076Z (about 2 years ago)
- Size: 121 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Clearcode's Pyziomki docker tools
Dockers with embedd tools used by Pyziomki team at Clearcode
## pyziomkidocktools
Based of off [sphinxdoc/sphinx](https://hub.docker.com/r/sphinxdoc/sphinx) with additional dependencies
* installed [myst-parser](https://myst-parser.readthedocs.io/en/latest/) for rendering markdown documents in sphinx
* installed [terraform-docs](https://github.com/terraform-docs/terraform-docs) for creating automatic terraform module documentation
* installed [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) for adding creating charts into documents
* installed [sphinxcontrib.confluencebuilder](https://pypi.org/project/sphinxcontrib-confluencebuilder/) to be able to publish documentation to confluence
## pyziomkireleasetools
Clean python based docker with:
* towncrier
# Release process
Checkout to main branch, and tag with new version with v prefix.