Doc tweaks and reusable CI #887
Conversation
2bndy5
force-pushed
the
doc-tweaks
branch
8 times, most recently
from
72e8fe0 to
97358ca
Compare
- show Table of Contents in Doxygen's Main/Related Pages - update sphinx customized CSS and conf.py - remove note about pyRF24 API
use latest doxygen release update set-output cmd in docs CI update action versions in docs CI
|
If the "slight refactor" is acceptable, then I'll go ahead and make the same changes to other RF24* libs' docs. |
|
I had to make some changes to the paths in the Doxyfile to get it working as per my commits, but not sure why the docs build is failing now... |
|
Because the paths were written so doxygen is executed from the root folder. I think your changes should work only if doxygen is executed from the docs folder. |
|
Aww crapOn Jan 2, 2023, at 2:22 PM, Brendan ***@***.***> wrote:
Because the paths were written so doxygen is execuged feim the root folder. I think your changes should work only if doxygen is executed from the docs folder.
—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you commented.Message ID: ***@***.***>
|
|
I'm on it. I'm going with the assumption that you want to build docs from the docs folder (not the root folder anymore). |
|
ok, I fixed it so doxygen should be executed from the docs folder. |
|
Yeah, I was executing it from the docs folder thinking it should be. I guess we can go with that now lol. |
|
If I ever incorporate doxygen into cmake (unlikely), then it will probably change again anyway. Honestly, I'd like to support clang better in cmake rather than doxygen. |
|
BTW, the sphinx-immaterial theme can make use of github discussions as user feedback (embedded directly in the doc pages via giscus). See my demo/test (scroll to bottom of page). Just thought I'd throw that out there. |
2bndy5
force-pushed
the
doc-tweaks
branch
2 times, most recently
from
2822d2a to
a686e95
Compare
|
I'm going to switch to using reusable workflows in most of the nRF24 org repos' CI. This will make updating the CI across all repos much easier (no more separate PR per repo). So far, the tests on this branch are successfully using workflows that I created in the nRF24/.github repo (on reusable-workflow branch). In other words the doc-update PRs are not finalized yet... |
2bndy5
force-pushed
the
doc-tweaks
branch
2 times, most recently
from
1fcf5dc to
3a20a9a
Compare
- revert some Doxygen CSS changes - update RTD build Update paths Update Doxyfile One more modification update all CI also amend readme instructions fix RTD build and some CI changes fix doxyfile config value keep doxygen output relative to root self review changes restore dynamic version number in Doxyfile
|
That felt rare. I don't often trigger hundreds of CI runs (across 6 org repos) simultaneously; even rarer that nothing went wrong. 🎉 |
|
Yeah I'm ready to move on from these Doc Updates PRs. The only thing left to look out for is release CI behavior, but I'm confidence that everything should go well. Rebasing the promiscuouos-scanners branch should be interesting because there's a new curses example there (with CMake and CI changes). |
I wanted to add a "table of contents" list to all Doxygen's "Main/Related Pages", but then I had to update the CI and doxygen CSS...
Doxygen now supports light and dark themes finally. 👀 I've set the new feature to be able to toggle light/dark theme (button is located next to search box). It should default to whatever theme the OS is using. This feature requires Doxygen v1.9.5+ (CI is now using v1.9.6).
Reduced old copy of customized Doxygen CSS; it was no longer compatible with latest version of Doxygen and the feature discussed above. Besides, it seemed like a simple dump of the default CSS from an older version Doxygen.
I also updated the sphinx CSS in accordance with the sphinx-immaterial theme v0.11.0 release.
Slight docs refactor
Both Doxyfile and the doxygen-custom.css files now exist in docs/ folder. This is done to try and reduce the clutter in root folder. I added some build instructions to the docs/README.md. Basically, this change means you have to run doxygen from the docs folder
instead of running doxygen from the root folder.