Skip to content
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

Improve documentation style #28

Merged
merged 4 commits into from
Feb 8, 2023
Merged

Improve documentation style #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed3bda0
Move to furo theme
ItsDrike Feb 7, 2023
1ec2342
Use py-mine org logo as favicon
ItsDrike Feb 7, 2023
a879872
Make some improvements to docs style
ItsDrike Feb 7, 2023
263f772
Add changelog fragment for #28
ItsDrike Feb 7, 2023
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
1 change: 1 addition & 0 deletions LICENSE-THIRD-PARTY.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Applies to:
- .github/workflows/fragment-check.yml: Entire file
- .github/workflows/prepare-release.yml: Workflow heavily inspired by original
- .github/scripts/normalize_coverage.py: Entire file
- docs/_static/extra.css: Entire file
---------------------------------------------------------------------------------------------------
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
1 change: 1 addition & 0 deletions changes/28.docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Use furo theme for the documentation
47 changes: 47 additions & 0 deletions docs/_static/extra.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
html {
word-wrap: anywhere;
}

body {
--toc-item-spacing-horizontal: 0.5rem;
--admonition-font-size: 0.8em;
}

.icon {
user-select: none;
}

.viewcode-back {
position: absolute;
right: 1em;
background-color: var(--color-code-background);
width: auto;
}

.toc-drawer {
width: initial;
max-width: 20em;
right: -20em;
}

.toc-tree ul ul ul ul {
border-left: 1px solid var(--color-background-border);
}

@media (max-width: 82em) {
body {
font-size: 0.7em;
}

.toc-tree {
padding-left: 0;
}

.sidebar-brand-text {
font-size: 1rem;
}

.sidebar-tree .reference {
padding: 0.5em 1em;
}
}
6 changes: 5 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,11 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "alabaster"
html_theme = "furo"
html_favicon = "https://i.imgur.com/nPCcxts.png"

html_static_path = ["_static"]
html_css_files = ["extra.css"]

# -- Extension configuration -------------------------------------------------

Expand Down
69 changes: 68 additions & 1 deletion poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ m2r2 = "^0.3.3.post2"
packaging = "^23.0"
sphinx-autodoc-typehints = "^1.22"
sphinx-copybutton = "^0.5.1"
furo = ">=2022.12.7"

[tool.poetry.group.docs-ci]
optional = true
Expand Down