ADC Sample
This is a demo site for ADC, generated as part of
Sphinx Themes Gallery.
Important
This sample documentation was generated on Dec 02, 2024, and is rebuilt weekly.
Quickstart
Install this theme:
$ pip install sphinx-adc-theme
Set the following in your existing Sphinx documentation’s conf.py
file:
import sphinx_adc_theme
html_theme = 'sphinx_adc_theme'
html_theme_path = [sphinx_adc_theme.get_html_theme_path()]
Build your Sphinx documentation with the new theme!
Documentation
This theme does not have any hosted-on-the-web documentation.
Exploration
The Kitchen Sink section contains pages that contains basically
everything that you can with Sphinx “out-of-the-box”.
Browsing through that section should give you a good idea of how stuff looks
in this theme.
Navigation
This is the most important part of a documentation theme. If you like
the general look of the theme, please make sure that it is possible to
easily navigate through this sample documentation.
Ideally, the pages listed below should also be reachable via links
somewhere else on this page (like the sidebar, or a topbar). If they are
not, then this theme might need additional configuration to provide the
sort of site navigation that’s necessary for “real” documentation.
Some pages like Placeholder Page Three are declared in a “hidden”
toctree, and thus would not be visible above. However, they are still a
part of the overall site hierarchy and some themes may choose to present
them to the user in the site navigation.