Skip to content

WIP: Added theming and dark mode support per #152. #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

WIP: Added theming and dark mode support per #152. #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ build
*.py[cod]

pdoc/_version.py
.python-version

venv
.venv
Expand All @@ -13,3 +14,4 @@ htmlcov
.*_cache/*

html/*
.eggs/
13 changes: 11 additions & 2 deletions pdoc/templates/config.mako
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@
# Enable syntax highlighting for code/source blocks by including Highlight.js
syntax_highlighting = True

# Set the style keyword such as 'atom-one-light' or 'github-gist'
# Set the style keywords such as 'atom-one-light' or 'github-gist'
# Options: https://github.com/highlightjs/highlight.js/tree/master/src/styles
# Demo: https://highlightjs.org/static/demo/
hljs_style = 'github'
#
# The first one is for "light mode" the second is for "dark mode".
hljs_style_tuple = ('github', 'atom-one-dark')

# If set, insert Google Analytics tracking code. Value is GA
# tracking id (UA-XXXXXX-Y).
Expand All @@ -61,4 +63,11 @@
# Note: in Python docstrings, either all backslashes need to be escaped (\\)
# or you need to use raw r-strings.
latex_math = False

# CSS Theming is done via templates and the full selection of base themes can
# be located in the default template directory - ../site-packages/pdoc/templates/themes/
# This way you can simply enter the name of the theme you wish to be used for your
# docs. You can also include a custom theme by filling out the `custom.mako` file and
# entering `custom` in the below setting.
css_theme = 'default'
%>
Loading