Doxygen style #26
Doxygen style #26
Conversation
_doxygen/openamp/footer.html
Outdated
| <script type="text/javascript"> | ||
| $(function() { | ||
| toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle') | ||
| toggleButton.title = "Toggle Light/Dark Mode" |
There was a problem hiding this comment.
I can not see the button in https://openamp--26.org.readthedocs.build/en/26/ page
But perhaps need to be merged to see it?
|
@arnopo The light dark button is only for the Doxygen right now, not the Sphinx. I am working on one more fix. Put the correct version number on the Doxygen page. |
|
Ok added one more patch to this PR. When I created the list of remaining issues (Issue #27 ) that one stuck out as it was not just cosmetic but was functionally incorrect. I have adjusted Issue #27 to remove this issue. Besides I had stuggled all day with west manifests and was looking for an easy "win" :) |
Add the logo and other appearance images from the project website. Signed-off-by: Bill Mills <[email protected]>
Make an exact copy of these files so it is easy to see what changed in the next commit. Signed-off-by: Bill Mills <[email protected]>
The logo svg files from the project website have a ton of white space. Edit new files and modify the viewBox=".." attribute to trim it. The new SVGs are 650 x 650 units with the logo centered. Signed-off-by: Bill Mills <[email protected]>
We will use doxygen-awesome-css to help style the Doxygen content. Import it as a submodule and set it to v2.2.1 (from 2023-06-01) Signed-off-by: Bill Mills <[email protected]>
Import these files as is from Zephyr.
From the main Zephyr repo from dir:
doc/_doxygen/
Signed-off-by: Bill Mills <[email protected]>
Rename the files from zephyr -> openamp. Signed-off-by: Bill Mills <[email protected]>
Adjust the files we copied from Zephyr to match our project. * Adjust Logo size and Logo area * Use the dark triangle background for the project site for the Logo area * Use a dark color for the nav area always (light and dark themes) * Adjust project specific js file name in header * Remove footer script and add simpler toggle activation to header * Make nav color match Sphinx * Make --primary-color the red accent from Sphinx * Take swag at other colors so they don't clash too much * Hide the TOC sync button as it just confused people (me) Signed-off-by: Bill Mills <[email protected]>
These Doxyfile settings will override / add to the ones in the submodules. * Use TOC tree on Left side (sidebar only style) * Style with doxygen-awesome-css * Style with openamp defs for awesome Signed-off-by: Bill Mills <[email protected]>
This layout file is the built-in default for doxygen 1.9.1 It can be generated via the command: $ doxygen -l Check it in as is and then configure to use it. There should be no difference in the output yet (assuming that you are using doxygen 1.9.1 or similar). Don't blame me for the trailing white space. This is how stock doxygen had it. Signed-off-by: Bill Mills <[email protected]>
In the navigation side bar, add a link to the main OpenAMP docs level. I would really like this to go _before_ the library title but I don't see a way to easily do that right now. Signed-off-by: Bill Mills <[email protected]>
In the Sphinx docs the logo is a clickable link to the top level. Make this true for the Doxygen content also. Right now the Doxygen logo does not provide hover feedback like the Sphinx level does. I assume this can be fixed with more CSS tweaks. Signed-off-by: Bill Mills <[email protected]>
* Use same Logo and background * Make it look similar when narrow (fix menu color) * Make version more visible. * Give some red accents in the nav bar * Make the RTD version header red Signed-off-by: Bill Mills <[email protected]>
Use the Read the Docs assigned version name for Doxygen. Also for both Doxygen and Sphinx use an intentionally different version name by default. Signed-off-by: Bill Mills <[email protected]>
wmamills
force-pushed
the
doxygen-style
branch
from
682600c
to
bfe0611
Compare
|
@nathalie-ckc @tammyleino Can I get a 2nd approval from one of you? Now that all the supporting PRs are in I have rebased and pushed again. Issue #27 has the todo list. Feel free to add more issues or edit #27 to add small items. |
There was a problem hiding this comment.
Approving based on clicking through the preview at https://openamp--26.org.readthedocs.build/en/26/
This is the Doxygen Style work and the updates to the Sphinx theme to match.
I suggest we accept this as a baseline and we can tweak later (before end of October or later depending on how things go.)
I think this is better than what we had and is pretty close.
I will make an issue for the remain style issues as I see them.
(This PR won't style open-amp as that repo has not accepted the style enable PR yet)