Skip to content

docs: replace previous docs with sphinx docs#154

Open
AloizioMacedo wants to merge 10 commits intocanonical:masterfrom
AloizioMacedo:infuse-rtd-docs-in-snap
Open

docs: replace previous docs with sphinx docs#154
AloizioMacedo wants to merge 10 commits intocanonical:masterfrom
AloizioMacedo:infuse-rtd-docs-in-snap

Conversation

@AloizioMacedo
Copy link
Copy Markdown
Contributor

@AloizioMacedo AloizioMacedo commented Apr 14, 2026

This PR replaces the previous documentation with the new one, which uses sphinx and leverages read the docs as hosting platform. As part of this, it does the last step of replacing the offline docs (it is convenient to do both at once when changing snapcraft.yaml, since we will not need to temporarily build two docs on the snap).

Before opening for review, this will wait for:

  • Formal approval on the spec, since it is a destructive process. Done
  • Other PRs that implement things related to the transition spec. As of this moment, docs: automate cli docs generation #144. Done

This will also finalize the transition process.


Tips on reviewing: Commits remove docs folder, remove offline-docs, rename rtd-docs to docs should be reviewed as high level changes, as they are only overarching removals and renamings.

@AloizioMacedo AloizioMacedo self-assigned this Apr 14, 2026
@AloizioMacedo AloizioMacedo added the documentation Improvements or additions to documentation label Apr 14, 2026
@AloizioMacedo AloizioMacedo force-pushed the infuse-rtd-docs-in-snap branch from a4b59ae to 43e31e4 Compare April 16, 2026 20:30
@AloizioMacedo AloizioMacedo marked this pull request as ready for review April 17, 2026 13:13
@AloizioMacedo AloizioMacedo requested a review from a team April 17, 2026 13:13
@AloizioMacedo AloizioMacedo force-pushed the infuse-rtd-docs-in-snap branch from 43e31e4 to 1498e29 Compare April 17, 2026 13:53
wyattrees
wyattrees previously approved these changes Apr 17, 2026
Copy link
Copy Markdown
Contributor

@wyattrees wyattrees left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, although it looks like some tests need to either be removed or refactored.

Also, if I'm not mistaken, the description of the PR gets included in the commit message when merge happens, so make sure that it complies with our conventional commits spec

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants