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.

Sign up for GitHub

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

Jump to bottom

Doxygen style #26

Merged
merged 13 commits into from
Oct 18, 2023
Merged

Doxygen style #26

merged 13 commits into from
Oct 18, 2023

Commits on Oct 17, 2023

  1. Add static image from openampproject.org website 

    Add the logo and other appearance images from the project website.

Signed-off-by: Bill Mills <[email protected]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    9a306f1 View commit details
    Browse the repository at this point in the history

  2. Doxygen: make copies of SVG logos in prep to trim them. 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    f804ddb View commit details
    Browse the repository at this point in the history

  3. Create _trim versions of OpenAMP logo SVGs 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    81f076d View commit details
    Browse the repository at this point in the history

  4. Doxygen: Import doxygen-awesome-css as a submodule 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    2180680 View commit details
    Browse the repository at this point in the history

  5. Doxygen: Import useful files from Zephyr Doxygen setup. 

    Import these files as is from Zephyr.
From the main Zephyr repo from dir:
    doc/_doxygen/

Signed-off-by: Bill Mills <[email protected]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    198bd7c View commit details
    Browse the repository at this point in the history

  6. Doxygen: Rename the zephyr files for our use 

    Rename the files from zephyr -> openamp.

Signed-off-by: Bill Mills <[email protected]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    b26f860 View commit details
    Browse the repository at this point in the history

  7. Doxygen: Adjust openamp files for our project 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    e94b723 View commit details
    Browse the repository at this point in the history

  8. Doxygen: Provide OpenAMP Doxyfile overrides. 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    d78f51b View commit details
    Browse the repository at this point in the history

  9. Doxygen: check in stock Doxygen layout file 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    21a93f9 View commit details
    Browse the repository at this point in the history

  10. Doxygen: add a back link to the navbar 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    9b768c7 View commit details
    Browse the repository at this point in the history

  11. Doxygen: make the logo a link to the top level. 

    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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    ac9edbb View commit details
    Browse the repository at this point in the history

  12. Sphinx: Make the style align with new Doxygen style 

    * 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]>
    @wmamills
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    de58a12 View commit details
    Browse the repository at this point in the history

  13. Doxygen: use the correct version name 

    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
    wmamills committed Oct 17, 2023
    Configuration menu
    Copy the full SHA
    bfe0611 View commit details
    Browse the repository at this point in the history