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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify Beluga documentation #346

Merged
merged 14 commits into from
May 9, 2024
Merged

Unify Beluga documentation #346

merged 14 commits into from
May 9, 2024

Conversation

hidmic
Copy link
Collaborator

@hidmic hidmic commented May 6, 2024

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 autodox extension in https://github.com/Ekumen-OS/sphinx-babel.

In the process, this PR partially addresses #301, #302, #303, #304, and #308.

Type of change

  • 馃悰 Bugfix (change which fixes an issue)
  • 馃殌 Feature (change which adds functionality)
  • 馃摎 Documentation (change which fixes or extends documentation)

馃挜 Breaking change! This patch changes the way we used to build documentation for the Beluga package.

Checklist

  • Lint and unit tests (if any) pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • All commits have been signed for DCO

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 docs for instructions, or simply:

git clone https://github.com/Ekumen-OS/beluga.git
cd beluga/docs
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
make html 

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.

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
@hidmic hidmic self-assigned this May 6, 2024
DEVELOPING.md Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

@hidmic This is absolutely amazing! I have a couple of quick questions about the setup before I start the review.

docs/requirements.txt Outdated Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
hidmic added 4 commits May 6, 2024 00:18
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 hidmic force-pushed the hidmic/unified-documentation branch from ba49496 to efa2b59 Compare May 6, 2024 03:42
hidmic added 3 commits May 6, 2024 09:55
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
Copy link
Collaborator Author

hidmic commented May 6, 2024

Looks like Rolling moved on to Noble already and we are getting build failures 馃憖

Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

@hidmic I love this! First pass, I'll continue the review later.

docs/getting-started/installation.md Outdated Show resolved Hide resolved
docs/concepts/key-concepts.md Outdated Show resolved Hide resolved
docs/concepts/key-concepts.md Outdated Show resolved Hide resolved
docs/concepts/key-concepts.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

LGTM!

hidmic added 3 commits May 7, 2024 18:26
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
Copy link
Collaborator Author

hidmic commented May 9, 2024

Rolling CI failures will be fixed by https://github.com/open-navigation/navigation2/pull/4267. Going in!

@hidmic hidmic merged commit 123ea96 into main May 9, 2024
12 of 13 checks passed
@hidmic hidmic deleted the hidmic/unified-documentation branch May 9, 2024 14:25
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>
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.

None yet

3 participants