Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs with sphinx for HC3 #2315

Merged
merged 5 commits into from
Sep 22, 2023
Merged

Docs with sphinx for HC3 #2315

merged 5 commits into from
Sep 22, 2023

Conversation

SebastianGode
Copy link
Member

Summary of the Pull Request

Adds required files and entries to be able to produce doc output for our HC3.

image

@SebastianGode
Copy link
Member Author

It could break your public documentation a bit as the toctree inside the index.md will likely be rendered there as well and that will look ugly.
Don't know if there's a good other solution.
https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/blob/docs-sphinx/docs/index.md

@anton-sidelnikov
Copy link
Member

Hello @SebastianGode, is it possible to keep current structure like in https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs ?

Current docs reads subcategory field and put docs in same place if category match, and the divide them on resources and data-sources:
image

@anton-sidelnikov
Copy link
Member

anton-sidelnikov commented Sep 20, 2023

maybe toctree will not renders if you put it in between ---
--- {toctree} ---

docs/data-sources/index.md Outdated Show resolved Hide resolved
docs/resources/index.md Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
@SebastianGode
Copy link
Member Author

SebastianGode commented Sep 20, 2023

maybe toctree will not renders if you put it in between --- --- {toctree} ---

This sadly doesn't work.
We could add it on build time, but I'm not sure on how to do this without making git aware of it.

artem-lifshits
artem-lifshits previously approved these changes Sep 21, 2023
@vladimirvshivkov vladimirvshivkov added the gate Merge PR label Sep 22, 2023
@otc-zuul
Copy link

otc-zuul bot commented Sep 22, 2023

Build succeeded.
https://zuul.otc-service.com/t/eco/buildset/4d46de45740d433fb82cc3fb24161b2f

✔️ build-otc-releasenotes SUCCESS in 5m 12s
✔️ otc-golangci-lint SUCCESS in 2m 53s
✔️ golang-make-test SUCCESS in 5m 30s
✔️ golang-make-vet SUCCESS in 5m 09s
✔️ tflint SUCCESS in 3m 00s
✔️ goreleaser-build SUCCESS in 6m 54s

@otc-zuul otc-zuul bot merged commit 82ff31a into devel Sep 22, 2023
@otc-zuul otc-zuul bot deleted the docs-sphinx branch September 22, 2023 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include TF docs in HC Include terraform into the index of docsportal
4 participants