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 Revamp #447

Merged
merged 10 commits into from
Nov 20, 2024
Merged

Docs Revamp #447

merged 10 commits into from
Nov 20, 2024

Conversation

cmsirbu
Copy link
Contributor

@cmsirbu cmsirbu commented Nov 8, 2024

  • Set up mkdocs project and build on RTD
  • RTD build installs collection from checked-out branch
  • Build plugin docs
  • Swap all existing docs to Markdown
  • Changelog - minor tweaks so it renders ok in the docs, but it should be revisited and reformatted.

In order for mkdocs to build documentation when running locally for development, the collection must be installed. It is now installed by the invoke docs command every time it is run in the repository subfolder called collections. This ensures it does not clash with any other locally installed collections.

@cmsirbu cmsirbu marked this pull request as ready for review November 18, 2024 12:41
@cmsirbu
Copy link
Contributor Author

cmsirbu commented Nov 18, 2024

This is ready for review - live build can be seen here: https://docs-landing-page--447.org.readthedocs.build/projects/ansible/en/447/

@cmsirbu cmsirbu linked an issue Nov 18, 2024 that may be closed by this pull request
@joewesch
Copy link
Contributor

Is there anything we can do to render the existing documentation formatting macros (e.g., C() for pre-formatted text and E() for environment variables) that are used for the ansible galaxy docs?

@cmsirbu
Copy link
Contributor Author

cmsirbu commented Nov 18, 2024

Is there anything we can do to render the existing documentation formatting macros (e.g., C() for pre-formatted text and E() for environment variables) that are used for the ansible galaxy docs?

It probably is doable, I've opened cmsirbu/mkdocs-ansible-collection#10 to track it. Won't have time to dig deep into it until I get through the remaining plugin types first for better coverage.

@jvanderaa jvanderaa merged commit 1565063 into develop Nov 20, 2024
7 checks passed
@cmsirbu cmsirbu deleted the cs-docs-revamp branch November 20, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Official Ansible Documentation Broken
3 participants