From 8f76be3410c1c5501a1188dbea800f17031eb05c Mon Sep 17 00:00:00 2001 From: Mateo de Mayo Date: Tue, 27 Jun 2023 13:30:24 -0300 Subject: [PATCH] doc: Use top header and remove doxygen-awesome readme page --- doc/Doxyfile.in | 2 - doc/doxygen-awesome-css/README.md | 166 ------------------------------ 2 files changed, 168 deletions(-) delete mode 100644 doc/doxygen-awesome-css/README.md diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index f2319a4e8..36f8f4d4b 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -103,8 +103,6 @@ FULL_SIDEBAR = NO HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5 HTML_HEADER = @SRCDIR@/doc/header.html HTML_EXTRA_STYLESHEET = @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome.css \ - @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ - @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css HTML_EXTRA_FILES = @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \ @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \ @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \ diff --git a/doc/doxygen-awesome-css/README.md b/doc/doxygen-awesome-css/README.md deleted file mode 100644 index 8108ca898..000000000 --- a/doc/doxygen-awesome-css/README.md +++ /dev/null @@ -1,166 +0,0 @@ -# Doxygen Awesome - -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/jothepro/doxygen-awesome-css)](https://github.com/jothepro/doxygen-awesome-css/releases/latest) -[![GitHub](https://img.shields.io/github/license/jothepro/doxygen-awesome-css)](https://github.com/jothepro/doxygen-awesome-css/blob/main/LICENSE) -![GitHub Repo stars](https://img.shields.io/github/stars/jothepro/doxygen-awesome-css) - -
- -![Screenshot of Doxygen Awesome CSS](img/screenshot.png) - -
- -**Doxygen Awesome** is a custom **CSS theme for Doxygen HTML-documentation** with lots of customization parameters. - -## Motivation - -I really like how the Doxygen HTML-documentation is structured! But IMHO it looks a bit outdated. - -This theme is an attempt to update the visuals of Doxygen without changing its overall layout too much. - -## Features - -- 🌈 Clean, modern design -- 🚀 Heavily customizable by adjusting CSS-variables -- 🧩 No changes to the HTML structure of Doxygen required -- 📱 Improved mobile usability -- 🌘 Dark mode support! -- 🥇 Works best with **doxygen 1.9.1** - **1.9.4** and **1.9.6** - **1.9.7** - -## Examples - -Some websites using this theme: - -- [Documentation of this repository](https://jothepro.github.io/doxygen-awesome-css/) -- [wxWidgets](https://docs.wxwidgets.org/3.2/) -- [OpenCV 5.x](https://docs.opencv.org/5.x/) -- [Zephyr](https://docs.zephyrproject.org/latest/doxygen/html/index.html) -- [FELTOR](https://mwiesenberger.github.io/feltor/dg/html/modules.html) -- [Spatial Audio Framework (SAF)](https://leomccormack.github.io/Spatial_Audio_Framework/index.html) -- [libCloudSync](https://jothepro.github.io/libCloudSync/) -- [libsl3](https://a4z.github.io/libsl3/) - -## Installation - -To use the theme when generating your documentation, bring the required CSS and JS files from this repository into your project. - -This can be done in several ways: - -- manually copying the files -- adding the project as a Git submodule -- adding the project as a npm/xpm dependency -- installing the theme system wide - -All theme files are located in the root of this repository and start with the prefix `doxygen-awesome-`. You may not need all of them. Follow the install instructions to figure out what files are required for your setup. - -### Git submodule - -For projects which use git, add the repository as a submodule and check out the desired release: - -```sh -git submodule add https://github.com/jothepro/doxygen-awesome-css.git -cd doxygen-awesome-css -git checkout v2.2.1 -``` - -### npm/xpm dependency - -In the npm ecosystem, this project can be added as a development dependency -to your project: - -```sh -cd your-project -npm install https://github.com/jothepro/doxygen-awesome-css#v2.2.1 --save-dev - -ls -l node_module/@jothepro/doxygen-awesome-css -``` - -Similarly, in the [xPack](https://xpack.github.io) ecosystem, this project can be added -as a development dependency to an [`xpm`](https://xpack.github.io/xpm/) -managed project. - -### System-wide - -You can even install the theme system-wide by running `make install`. The files will be installed to `/usr/local/share/` by default, but you can customize the install location with `make PREFIX=/my/custom/path install`. - -### Choosing a layout - -There is two layout options. Choose one of them and configure Doxygen accordingly: - -
- -![Available theme variants](img/theme-variants.drawio.svg) - -
- -
- -- 1️⃣ Base Theme - Comes with the typical Doxygen titlebar. Optionally the treeview in the sidebar can be enabled. - - Required files: `doxygen-awesome.css` - - Required `Doxyfile` configuration: - ``` - GENERATE_TREEVIEW = YES # optional. Also works without treeview - DISABLE_INDEX = NO - FULL_SIDEBAR = NO - HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css - HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5 - ``` - -- 2️⃣ Sidebar-Only Theme - Hides the top titlebar to give more space to the content. The treeview must be enabled in order for this theme to work. - - Required files: `doxygen-awesome.css`, `doxygen-awesome-sidebar-only.css` - - Required `Doxyfile` configuration: - ``` - - GENERATE_TREEVIEW = YES # required! - DISABLE_INDEX = NO - FULL_SIDEBAR = NO - HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \ - doxygen-awesome-css/doxygen-awesome-sidebar-only.css - HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5 - ``` - -
- -**Caution**: -- This theme is not compatible with the `FULL_SIDEBAR = YES` option provided by Doxygen! -- `HTML_COLORSTYLE` must be set to `LIGHT` since Doxygen 1.9.5! - -### Further installation instructions: - -- [Installing extensions](docs/extensions.md) -- [Customizing the theme (colors, spacing, border-radius, ...)](docs/customization.md) -- [Tips and Tricks for further configuration](docs/tricks.md) - -## Browser support - -Tested with - -- Chrome 110, Chrome 109 for Android, Chrome 110 for iOS -- Safari 16, Safari for iOS 16 -- Firefox 110, Firefox 110 for Android, Firefox 109 for iOS -- Edge 110 - - -The theme does not strive to be backwards compatible to (significantly) older browser versions. - - -## Credits - -Thanks for all the bug reports and inspiring feedback on github! - -Special thanks to all the contributors: -

- - - - - - -Read Next: [Extensions](docs/extensions.md) - \ No newline at end of file