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

various improvements to docs #844

Merged
merged 14 commits into from
Jun 12, 2022
Merged

various improvements to docs #844

merged 14 commits into from
Jun 12, 2022

Conversation

2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Jun 11, 2022

This includes spelling fixes, updates for the latest release of sphinx-immaterial theme, and fixes #841 (as per feedback provided there).

I also reduced the Doxyfile to only options that we change from their default value. This should help avoid warnings in future Doxygen output.

Note to devs: We cannot use Doxygen v1.9.3 (& possibly v1.9.2) due to erroneous XML output that broke compatibility with Sphinx's breathe extension. Recommend v1.9.4+

In reference to #814 The sphinx docs use the prototype idea from that thread (see the RF24 API page). Doxygen is proving very inflexible in solving that problem (so far).

@2bndy5 2bndy5 marked this pull request as ready for review June 11, 2022 23:16
@2bndy5 2bndy5 requested a review from TMRh20 June 11, 2022 23:17
Copy link
Member

@TMRh20 TMRh20 left a comment

Choose a reason for hiding this comment

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

Looks good.
One thing thats missing from the CMAKE instructions is the installer you created. Do you want to add that to the CMAKE docs? I think some users may prefer to use it to install all the libraries.

@2bndy5
Copy link
Member Author

2bndy5 commented Jun 12, 2022

The automated install instruction still exist in the old Linux install doc. It would be appropriate to move them to the CMake doc since it is now based on CMake. I'd probably leave a link to the automated install instructions in its place on the old Linux install doc.

Or I could add a link to the CMake doc to the automated install instructions... But that would be the lazy approach.

@TMRh20
Copy link
Member

TMRh20 commented Jun 12, 2022

The automated install instruction still exist in the old Linux install doc.

I don't see a link to the new installer, just the old installer using makefiles etc.. and instructions for that. I'd like to keep both installers now that we have them - there are older tutorials etc linking to the old installer as well.

@2bndy5
Copy link
Member Author

2bndy5 commented Jun 12, 2022

Oops, I thought you changed the link to the auto-installer. If you want to keep both, then that makes the request easier.

@2bndy5 2bndy5 requested a review from TMRh20 June 12, 2022 12:38
@TMRh20 TMRh20 merged commit aa815f7 into master Jun 12, 2022
@2bndy5 2bndy5 deleted the improve-sphinx-docs branch June 12, 2022 13:17
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.

How do I build a modified .cpp example for raspberry pi?
2 participants