diff --git a/docs/index.rst b/docs/index.rst index 0b70af8c..a970c495 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,6 +8,7 @@ CrateDB Documentation Theme A theme component for the `Sphinx`_ static documentation generator used by the `CrateDB Documentation`_ across the board. +It derives from and builds upon the excellent `sphinx-basic-ng`_ and `Furo`_. .. rubric:: Introduction @@ -104,5 +105,7 @@ How to improve this documentation: .. _CrateDB Documentation: https://cratedb.com/docs/ .. _developer guide: https://github.com/crate/crate-docs-theme/blob/main/DEVELOP.rst +.. _Furo: https://github.com/pradyunsg/furo .. _report an issue: https://github.com/crate/crate-docs-theme/issues/new .. _Sphinx: https://www.sphinx-doc.org/ +.. _sphinx-basic-ng: https://github.com/pradyunsg/sphinx-basic-ng diff --git a/src/crate/theme/rtd/crate/static/vendor/furo/README.md b/src/crate/theme/rtd/crate/static/vendor/furo/README.md deleted file mode 100644 index f4924dc0..00000000 --- a/src/crate/theme/rtd/crate/static/vendor/furo/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Vendored Furo styles and scripts - -## About - -This theme derives from [sphinx-basic-ng], but needs a few components from -[Furo]. For example, the menu builder from Furo's `navigation.py` is made -available to the HTML context via `ng_navigation_tree`. - -Therefore, it needs to vendorize a few styles. It can not take the whole -thing, because Furo's colors currently interfere with the colors provided -by the theme's styles. - -```{todo} -Completely migrate to Furo's color system? -``` - -## License - -Furo's license is the MIT license. -> Copyright (c) 2020 Pradyun Gedam - - -[Furo]: https://github.com/pradyunsg/furo -[sphinx-basic-ng]: https://github.com/pradyunsg/sphinx-basic-ng