mantik and documentation appear as one
Summary
In order to have mantik and its documentation without break of styles, we will set-up the mantik documentation with a style analogously to mantik landing page.
Acceptance Criteria
-
mantik documentation uses material design -
mantik styles are used for the documentation pages (see details for what belongs to it) -
backlink to mantik landing page
Given I am on the mantik docs page
And there is the mantik icon in the upper left corner of the header
When I click the icon
Then I will be directed to cloud.mantik.ai
-
mantik docs header has the same style as cloud.mantik.ai (eg. with the same logo) -
mantik docs header keeps search bar, icon link to gitlab (https://gitlab.com/mantik-ai - specifically only the icon, not the text)
Testing
Additional Notes / Information
What makes the mantik style (to be completed within refinement):
- font
- font sizes
- color schemes
We could consider using: https://squidfunk.github.io/mkdocs-material/
Technical Information
How to add custom content, structure, styling and code functionality to sphinx material theme:
- Customize
html_theme_options
inconf.py
to change top level titles, colors etc. - Add
html_css_file=["custom.css"]
toconf.py
and customizesource/_static/custom.css
to change styling - Add
html_js_file=["custom.js"]
toconf.py
and customizesource/_static/custom.js
to add javascript functionalities - Add
templates_path = ["_templates"]
toconf.py
and add any template you want tosource/_templates
- Temlpates for the sphinx material theme can be copied from for example https://github.com/bashtage/sphinx-material/blob/main/sphinx_material/sphinx_material/
Suggested Implementation
-
upgrade already used https://bashtage.github.io/sphinx-material/ -
adapt theme.conf
: colors, fonts, fontsizes -
header should appear similar in terms of spacing and sizes -
remove the links to previous & next page in the footer (pagination) -
finish up with rico in a paired session
/cc @rico.berner
Edited by Rico Berner