Unify Beluga documentation #346
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
hidmic
commented
May 6, 2024
hidmic
commented
May 6, 2024
hidmic
commented
May 6, 2024
hidmic
commented
May 6, 2024
hidmic
commented
May 6, 2024
hidmic
commented
May 6, 2024
There was a problem hiding this comment.
@hidmic This is absolutely amazing! I have a couple of quick questions about the setup before I start the review.
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
hidmic
force-pushed
the
hidmic/unified-documentation
branch
from
ba49496
to
efa2b59
Compare
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
|
Looks like Rolling moved on to Noble already and we are getting build failures 👀 |
There was a problem hiding this comment.
@hidmic I love this! First pass, I'll continue the review later.
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
|
Rolling CI failures will be fixed by https://github.com/open-navigation/navigation2/pull/4267. Going in! |
7 tasks
hidmic
added a commit
that referenced
this pull request
May 9, 2024
### Proposed changes This patch fixes https://ekumen-os.github.io/beluga styling, which #346 broke. #### Type of change - [x] 🐛 Bugfix (change which fixes an issue) - [ ] 🚀 Feature (change which adds functionality) - [ ] 📚 Documentation (change which fixes or extends documentation) ### Checklist - [x] Lint and unit tests (if any) pass locally with my changes - [x] I have added tests that prove my fix is effective or that my feature works - [x] I have added necessary documentation (if appropriate) - [x] All commits have been signed for [DCO](https://developercertificate.org/) Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
This was referenced May 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This patch unifies all repository documentation in a common Sphinx site: high-level documentation lives in MyST flavor Markdown documents, Doxygen API documentation is pulled in using the
autodoxextension in https://github.com/Ekumen-OS/sphinx-babel.In the process, this PR partially addresses #301, #302, #303, #304, and #308.
Type of change
💥 Breaking change! This patch changes the way we used to build documentation for the Beluga package.
Checklist
Additional comments
This patch gets us 80% of the way towards release ready documentation. High-level documentation is not as polished as I would like to (specially the Key Concepts page), but this patch is big enough already and I'm too drained to produce quality technical writing. The easiest way to review this is building documentation locally and exploring it. You can check the README file under
docsfor instructions, or simply:Note this documentation needs Python 3.9 or later to build. I was not able to get all dependencies to play ball in earlier Python versions.