################
Sphinx-Terraform
################
.. container:: tagline
A Sphinx_ extension for documenting **Terraform** modules.
.. container:: center
|docs_badge| |test_badge| |lic_badge| |pypi_badge| |download_badge| |black_badge|
.. |docs_badge| image:: https://gitlab.com/cblegare/sphinx-terraform/badges/main/pipeline.svg?job=pages&key_text=docs
:target: https://gitlab.com/cblegare/sphinx-terraform/-/pipelines
:alt: Gitlab - Docs
.. |test_badge| image:: https://gitlab.com/cblegare/sphinx-terraform/badges/main/coverage.svg?job=coverage
:target: https://gitlab.com/cblegare/sphinx-terraform/-/pipelines
:alt: Gitlab - Coverage
.. |lic_badge| image:: https://img.shields.io/pypi/l/sphinx-terraform?color=blue
:target: https://gitlab.com/cblegare/sphinx-terraform/-/blob/main/LICENSE
:alt: PyPI - License
.. |release_badge| image:: https://gitlab.com/cblegare/sphinx-terraform/-/badges/release.svg
:target: https://gitlab.com/cblegare/sphinx-terraform/-/releases
:alt: Gitlab - Release
.. |pypi_badge| image:: https://img.shields.io/pypi/v/sphinx-terraform
:target: https://pypi.org/project/sphinx-terraform
:alt: PyPI - Release
.. |download_badge| image:: https://img.shields.io/pypi/dm/sphinx-terraform
:target: https://pypi.org/project/sphinx-terraform/
:alt: PyPI - Downloads
.. |black_badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Formatting - Black
**Sphinx-Terraform** is simple to use and integrate smoothly with your Terraform codebase.
Programs must be written for people to read, and only incidentally
for machines to execute.
-- `SICP <https://mitpress.mit.edu/sites/default/files/sicp/index.html>`__
Code can become reusable when it is clearly visible, searchable and
referenceable. **Sphinx-Terraform** will help
* **make reusable modules** that application developers will find easier
to find, understand and use, thus reducing bugs, support time and *toil*;
* **show value to stakeholders**, since Infrastructure as Code is an abstract
and obscure topic for non-practitioners;
* **promote knowledge** and foster a community spirit around your code;
* **keep track** of *why* things work the way they do.
----
`Read the documentation! <documentation>`_
**Sphinx-Terraform** is
- `Hosted on Gitlab <https://gitlab.com/cblegare/sphinx-terraform>`__
- `Mirrored on Github <https://github.com/cblegare/sphinx-terraform>`__
- `Distributed on PyPI <https://pypi.org/project/sphinx-terraform/>`__
- `Documented online <https://cblegare.gitlab.io/sphinx-terraform/>`__
.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html
.. _HashiCorp: https://www.hashicorp.com/
.. _documentation: https://cblegare.gitlab.io/sphinx-terraform
Raw data
{
"_id": null,
"home_page": "https://cblegare.gitlab.io/sphinx-terraform",
"name": "sphinx-terraform-ch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "hcl tf terraform sphinx iac cloud infrastructure",
"author": "Charles Bouchard-L\u00e9gar\u00e9",
"author_email": "charlesbouchardlegare@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c4/d2/51d755d492327db821de435d51e527a597e43cd51f98e978221cc2f86804/sphinx_terraform_ch-2024.5.7.post4.tar.gz",
"platform": null,
"description": "################\nSphinx-Terraform\n################\n\n.. container:: tagline\n\n A Sphinx_ extension for documenting **Terraform** modules.\n\n.. container:: center\n\n |docs_badge| |test_badge| |lic_badge| |pypi_badge| |download_badge| |black_badge|\n\n.. |docs_badge| image:: https://gitlab.com/cblegare/sphinx-terraform/badges/main/pipeline.svg?job=pages&key_text=docs\n :target: https://gitlab.com/cblegare/sphinx-terraform/-/pipelines\n :alt: Gitlab - Docs\n\n.. |test_badge| image:: https://gitlab.com/cblegare/sphinx-terraform/badges/main/coverage.svg?job=coverage\n :target: https://gitlab.com/cblegare/sphinx-terraform/-/pipelines\n :alt: Gitlab - Coverage\n\n.. |lic_badge| image:: https://img.shields.io/pypi/l/sphinx-terraform?color=blue\n :target: https://gitlab.com/cblegare/sphinx-terraform/-/blob/main/LICENSE\n :alt: PyPI - License\n\n.. |release_badge| image:: https://gitlab.com/cblegare/sphinx-terraform/-/badges/release.svg\n :target: https://gitlab.com/cblegare/sphinx-terraform/-/releases\n :alt: Gitlab - Release\n\n.. |pypi_badge| image:: https://img.shields.io/pypi/v/sphinx-terraform\n :target: https://pypi.org/project/sphinx-terraform\n :alt: PyPI - Release\n\n.. |download_badge| image:: https://img.shields.io/pypi/dm/sphinx-terraform\n :target: https://pypi.org/project/sphinx-terraform/\n :alt: PyPI - Downloads\n\n.. |black_badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Formatting - Black\n\n**Sphinx-Terraform** is simple to use and integrate smoothly with your Terraform codebase.\n\n Programs must be written for people to read, and only incidentally\n for machines to execute.\n\n -- `SICP <https://mitpress.mit.edu/sites/default/files/sicp/index.html>`__\n\n\nCode can become reusable when it is clearly visible, searchable and\nreferenceable. **Sphinx-Terraform** will help\n\n* **make reusable modules** that application developers will find easier\n to find, understand and use, thus reducing bugs, support time and *toil*;\n\n* **show value to stakeholders**, since Infrastructure as Code is an abstract\n and obscure topic for non-practitioners;\n\n* **promote knowledge** and foster a community spirit around your code;\n\n* **keep track** of *why* things work the way they do.\n\n----\n\n`Read the documentation! <documentation>`_\n\n**Sphinx-Terraform** is\n\n- `Hosted on Gitlab <https://gitlab.com/cblegare/sphinx-terraform>`__\n- `Mirrored on Github <https://github.com/cblegare/sphinx-terraform>`__\n- `Distributed on PyPI <https://pypi.org/project/sphinx-terraform/>`__\n- `Documented online <https://cblegare.gitlab.io/sphinx-terraform/>`__\n\n.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html\n.. _HashiCorp: https://www.hashicorp.com/\n.. _documentation: https://cblegare.gitlab.io/sphinx-terraform\n",
"bugtrack_url": null,
"license": "BSD-2-Clause-Patent",
"summary": "A fork of a Sphinx extension for documenting Terraform modules.",
"version": "2024.5.7.post4",
"project_urls": {
"Documentation": "https://cblegare.gitlab.io/sphinx-terraform",
"Homepage": "https://cblegare.gitlab.io/sphinx-terraform",
"Issue Tracker": "https://gitlab.com/cblegare/sphinx-terraform/-/issues",
"Source": "https://gitlab.com/cblegare/sphinx-terraform"
},
"split_keywords": [
"hcl",
"tf",
"terraform",
"sphinx",
"iac",
"cloud",
"infrastructure"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7947fe9c3e53b35583ff06f783040c32864d623c195171f10b1e3095e25a9af",
"md5": "8814c266a44208ed3a36e0e392d239e9",
"sha256": "9be6a54d7cbfa1fbdb4f75f0c6b6b936457a592a7cf7611a6037e2b8d42a5130"
},
"downloads": -1,
"filename": "sphinx_terraform_ch-2024.5.7.post4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8814c266a44208ed3a36e0e392d239e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 27507,
"upload_time": "2024-05-07T22:22:47",
"upload_time_iso_8601": "2024-05-07T22:22:47.585014Z",
"url": "https://files.pythonhosted.org/packages/e7/94/7fe9c3e53b35583ff06f783040c32864d623c195171f10b1e3095e25a9af/sphinx_terraform_ch-2024.5.7.post4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4d251d755d492327db821de435d51e527a597e43cd51f98e978221cc2f86804",
"md5": "848bd806813ae0477aef0ff56dd9d02b",
"sha256": "d3065a215ce5e0682c7e931393337e91038856477469f7cdd2f814ba353bad60"
},
"downloads": -1,
"filename": "sphinx_terraform_ch-2024.5.7.post4.tar.gz",
"has_sig": false,
"md5_digest": "848bd806813ae0477aef0ff56dd9d02b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 54405,
"upload_time": "2024-05-07T22:22:48",
"upload_time_iso_8601": "2024-05-07T22:22:48.661229Z",
"url": "https://files.pythonhosted.org/packages/c4/d2/51d755d492327db821de435d51e527a597e43cd51f98e978221cc2f86804/sphinx_terraform_ch-2024.5.7.post4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-07 22:22:48",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "cblegare",
"gitlab_project": "sphinx-terraform",
"lcname": "sphinx-terraform-ch"
}
JSON