[0/6] Documentation theming update

24290 mbox series

Hi all,

This series includes the internally proposed theming update for the
libcamera docs. The current result can be inspected here:

http://libcamera2.stefanklug.com/

The biggest issue still remaining is the installation style of the docs.
Currently we install html, api-html and internal-api-html. This doesn't
fit too well with the new structure where api and internal-api live
inside the html directory. My tendency would be to move everything below
html, but then we have nothing to install when spinx is not available...

Maybe someone else has a opinion on that one.

Best regards,
Stefan


Stefan Klug (6):
  documentation: Add doxygen-awesome-css
  documentation: Enable doxygen-awesome-css
  Documentation: Use the sphinx book theme
  documentation: Include API docs in the sphinx documentation
  documentation: mainpage: Make it easier to distinguish Public and
    Internal API
  documentation: Drop unnecessary documentation-contents.rst

 Documentation/Doxyfile-common.in              |    5 +
 Documentation/camera-sensor-model.rst         |    2 -
 Documentation/code-of-conduct.rst             |    2 -
 Documentation/coding-style.rst                |    2 -
 Documentation/conf.py.in                      |   19 +-
 Documentation/documentation-contents.rst      |   35 -
 .../doxygen-awesome-darkmode-toggle.js        |  157 +
 .../doxygen-awesome-fragment-copy-button.js   |   85 +
 .../doxygen-awesome-interactive-toc.js        |   91 +
 .../doxygen-awesome-paragraph-link.js         |   51 +
 ...n-awesome-sidebar-only-darkmode-toggle.css |   40 +
 .../doxygen-awesome-sidebar-only.css          |  116 +
 .../doxygen-awesome-tabs.js                   |   90 +
 .../doxygen-awesome-css/doxygen-awesome.css   | 2683 +++++++++++++++++
 Documentation/environment_variables.rst       |    2 -
 Documentation/feature_requirements.rst        |    2 -
 .../guides/application-developer.rst          |    2 -
 Documentation/guides/ipa.rst                  |    2 -
 Documentation/guides/pipeline-handler.rst     |    2 -
 Documentation/guides/tracing.rst              |    2 -
 Documentation/index.rst                       |   31 +-
 Documentation/introduction.rst                |    8 -
 Documentation/lens_driver_requirements.rst    |    2 -
 Documentation/libcamera_architecture.rst      |    2 -
 Documentation/mainpage.dox                    |    6 +-
 Documentation/meson.build                     |   24 +-
 Documentation/python-bindings.rst             |    2 -
 Documentation/sensor_driver_requirements.rst  |    2 -
 Documentation/software-isp-benchmarking.rst   |    2 -
 Documentation/theme/footer.html               |   14 -
 Documentation/theme/layout.html               |  109 -
 Documentation/theme/search.html               |   63 -
 Documentation/theme/static/css/theme.css      |  295 --
 Documentation/theme/static/logo-and-text.svg  |  223 ++
 Documentation/theme/static/search.png         |  Bin 482 -> 0 bytes
 Documentation/theme/theme.conf                |    7 -
 README.rst                                    |    4 +-
 37 files changed, 3600 insertions(+), 584 deletions(-)
 delete mode 100644 Documentation/documentation-contents.rst
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome-interactive-toc.js
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome-paragraph-link.js
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome-sidebar-only.css
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome-tabs.js
 create mode 100644 Documentation/doxygen-awesome-css/doxygen-awesome.css
 delete mode 100644 Documentation/theme/footer.html
 delete mode 100644 Documentation/theme/layout.html
 delete mode 100644 Documentation/theme/search.html
 delete mode 100644 Documentation/theme/static/css/theme.css
 create mode 100644 Documentation/theme/static/logo-and-text.svg
 delete mode 100644 Documentation/theme/static/search.png
 delete mode 100644 Documentation/theme/theme.conf