Skip to content

Commit 9a9effd

Browse files
committed
style(docs): enhance CSS for better readability and maintainability
Improve the styling of the documentation by adding more space at the bottom of the page and overriding the minimum height for content to ensure full viewport height. Mark external links with an icon for better user experience. Simplify and consolidate CSS rules for consistency and easier maintenance. Adjust heading padding for better visual hierarchy. These changes aim to enhance the overall look and feel of the documentation, making it more user-friendly and visually appealing. chore(mkdocs.yml): update mkdocs configuration for better documentation generation Reorganize the mkdocs.yml file to improve the configuration of plugins and extensions. Move the autorefs plugin to a more logical position and update its settings for resolving closest references. Adjust mkdocstrings settings to show category headings and merge __init__ into class documentation. Modify signature and docstring settings for better readability. These changes aim to improve the documentation generation process, making it more efficient and the output more informative.
1 parent b2cd33c commit 9a9effd

File tree

4 files changed

+777
-598
lines changed

4 files changed

+777
-598
lines changed

docs/content/assets/stylesheets/extra.css

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44
max-width: 75rem;
55
}
66

7+
/* More space at the bottom of the page. */
8+
.md-main__inner {
9+
margin-bottom: 1.5rem;
10+
}
11+
12+
13+
/* override md-content min-height */
14+
.md-content {
15+
min-height: 100vh;
16+
}
17+
718
/* Shrink header and footer to the content size*/
819
.md-grid {
920
/* Default 61rem */
@@ -178,4 +189,16 @@
178189
img[src$="#gh-light-mode-only"] {
179190
display: none;
180191
}
192+
}
193+
194+
/* Mark external links as such (also in nav) */
195+
a.external:hover::after,
196+
a.md-nav__link[href^="https:"]:hover::after {
197+
/* https://primer.style/octicons/link-external-16 */
198+
background-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path fill="rgb(233, 235, 252)" d="M10.604 1h4.146a.25.25 0 01.25.25v4.146a.25.25 0 01-.427.177L13.03 4.03 9.28 7.78a.75.75 0 01-1.06-1.06l3.75-3.75-1.543-1.543A.25.25 0 0110.604 1zM3.75 2A1.75 1.75 0 002 3.75v8.5c0 .966.784 1.75 1.75 1.75h8.5A1.75 1.75 0 0014 12.25v-3.5a.75.75 0 00-1.5 0v3.5a.25.25 0 01-.25.25h-8.5a.25.25 0 01-.25-.25v-8.5a.25.25 0 01.25-.25h3.5a.75.75 0 000-1.5h-3.5z"></path></svg>');
199+
height: 0.8em;
200+
width: 0.8em;
201+
margin-left: 0.2em;
202+
content: ' ';
203+
display: inline-block;
181204
}

0 commit comments

Comments
 (0)