forked from aiidaplugins/aiida-lammps
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(WIP) Documentation improvements related to aiidaplugins#77
Changing the theme of the documentation to make it more similar to the qe theme. Adding a tutorial for the minimization calculation. General improvements to the documentation.
- Loading branch information
Jonathan Chico
committed
Nov 17, 2023
1 parent
928a0e1
commit 076ca75
Showing
30 changed files
with
972 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,4 +44,4 @@ pip-wheel-metadata | |
| # Docs | ||
| docs/_build/ | ||
| docs/build | ||
| docs/source/reference/apidoc | ||
| docs/source/reference/api | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Makefile for Sphinx documentation | ||
| # | ||
|
|
||
| # You can set these variables from the command line. | ||
| SPHINXOPTS = | ||
| SPHINXBUILD = sphinx-build | ||
| PAPER = | ||
| BUILDDIR = build | ||
|
|
||
| # User-friendly check for sphinx-build | ||
| ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) | ||
| $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) | ||
| endif | ||
|
|
||
| # Internal variables. | ||
| PAPEROPT_a4 = -D latex_paper_size=a4 | ||
| PAPEROPT_letter = -D latex_paper_size=letter | ||
| ALLSPHINXOPTS = -n -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source | ||
| # the i18n builder cannot share the environment and doctrees with the others | ||
| I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source | ||
|
|
||
| .PHONY: all help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext customdefault | ||
|
|
||
| customdefault: | ||
| $(SPHINXBUILD) -b html -nW --keep-going $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
|
|
||
| all: clean html view | ||
|
|
||
| clean: | ||
| rm -rf $(BUILDDIR) | ||
| rm -rf $(shell find . -type d -wholename "*/reference/api/auto") | ||
|
|
||
| html: | ||
| $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| @echo | ||
| @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | ||
|
|
||
| view: | ||
| open $(BUILDDIR)/html/index.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /* Fix CSS of top bar link icons */ | ||
| a.nav-link.nav-external i { | ||
| padding-left: 0.3em !important; | ||
| font-size: inherit !important; | ||
| vertical-align: inherit !important; | ||
| } | ||
| /* Current fix for https://github.com/pandas-dev/pydata-sphinx-theme/issues/193 */ | ||
| dl.field-list { | ||
| display: grid; | ||
| grid-template-columns: fit-content(30%) minmax(0, 1fr); | ||
| } | ||
| /* For icon unicodes see https://fontawesome.com/v4.7.0/icons/ */ | ||
| .title-icon-rocket .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f135" | ||
| } | ||
| .title-icon-info-circle .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f05a" | ||
| } | ||
| .title-icon-question-circle .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f059" | ||
| } | ||
| .title-icon-download .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f019" | ||
| } | ||
| .title-icon-external-link .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f08e" | ||
| } | ||
| .title-icon-lightbulb .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f0eb" | ||
| } | ||
| .title-icon-wrench .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f0ad" | ||
| } | ||
| .title-icon-cog .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f013" | ||
| } | ||
| .title-icon-cogs .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f085" | ||
| } | ||
| .title-icon-code-fork .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f126" | ||
| } | ||
| /* Semantic icon names */ | ||
| .title-icon-launch-software .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f135" /* rocket */ | ||
| } | ||
| .title-icon-install-software .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f019" /* download */ | ||
| } | ||
| .title-icon-information .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f05a" /* info-circle */ | ||
| } | ||
| .title-icon-tip .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f0eb" /* lightbulb */ | ||
| } | ||
| .title-icon-important .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f06a" /* exclamation-circle */ | ||
| } | ||
| .title-icon-warning .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f071" /* exclamation-triangle */ | ||
| } | ||
| .title-icon-troubleshoot .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f0ad" /* wrench */ | ||
| } | ||
| .title-icon-read-more .admonition-title:before { | ||
| margin-right:.5rem; | ||
| content: "\f518" /* external-link */ | ||
| } | ||
|
|
||
| .dropdown-group .dropdown .summary-title { | ||
| border-bottom: 0 !important; | ||
| font-weight:700 !important; | ||
| } | ||
| .dropdown-group .dropdown:not(:last-child) { | ||
| margin-bottom: 0 !important; | ||
| border-radius: 0 !important; | ||
| } | ||
| .dropdown-group .dropdown:first-child, | ||
| .dropdown-group .dropdown:first-child .summary-title { | ||
| border-radius: 1rem 1rem 0rem 0rem !important; | ||
| } | ||
| .dropdown-group .dropdown:last-child, | ||
| .dropdown-group .dropdown:last-child .summary-title { | ||
| border-radius: 0rem 0rem 1rem 1rem !important; | ||
| } | ||
|
|
||
| .dropdown-group .dropdown:last-child { | ||
| margin-bottom: 24px !important; | ||
| } | ||
|
|
||
| div.admonition :last-child { | ||
| margin-bottom: 0 | ||
| } | ||
|
|
||
| div.highlight-bash div.highlight { | ||
| background-color: aliceblue; | ||
| } | ||
|
|
||
| div.highlight-console div.highlight { | ||
| background-color: aliceblue; | ||
| } | ||
|
|
||
| .aiida-green { | ||
| color: #32B805; | ||
| } | ||
|
|
||
| .aiida-blue { | ||
| color: #0496DE; | ||
| } | ||
|
|
||
| .aiida-orange { | ||
| color: #FF7D16; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| .logo-table td { | ||
| padding: 20px 10px; | ||
| } | ||
|
|
||
| .center { | ||
| text-align: center; | ||
| max-width: 90%; | ||
| } | ||
|
|
||
| .bigfont { | ||
| font-size: 140%; | ||
| } | ||
|
|
||
| .navbar-brand { | ||
| padding: 0; | ||
| padding-top: 0.5rem; | ||
| } | ||
|
|
||
| img.logo__image { | ||
| max-height: 180px; | ||
| padding-left: 1.5rem; | ||
| padding-bottom: 1rem; | ||
| } | ||
|
|
||
| .navbar-icon-links i.fa-brands { | ||
| font-size: 40px!important; | ||
| } | ||
|
|
||
| img.aiida-sidebar-logo { | ||
| height: 40px!important; | ||
| } | ||
|
|
||
| img.aiida-logo { | ||
| width: 20px; | ||
| padding-bottom: 3px; | ||
| } | ||
|
|
||
| .fa { | ||
| color: var(--pst-color-primary); | ||
| } | ||
|
|
||
| .bd-search { | ||
| padding: 0 1rem; | ||
| } | ||
|
|
||
| .tutor-footer { | ||
| padding-top: 0rem; | ||
| border-top: none!important; | ||
| } | ||
|
|
||
| .footer-table { | ||
| margin-bottom: 0rem; | ||
| border-color: transparent; | ||
| } | ||
|
|
||
| .footer-table td:last-child { | ||
| text-align: right; | ||
| } |
File renamed without changes
File renamed without changes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| {%- macro icon_link_nav_item(url, icon, name, type, attributes='') -%} | ||
| {%- if url | length > 2 %} | ||
| <li class="nav-item"> | ||
| {%- set attributesDefault = { "href": url, "title": name, "class": "nav-link", "rel": "noopener", "target": "_blank", "data-bs-toggle": "tooltip", "data-bs-placement": "bottom"} %} | ||
| {%- if attributes %}{% for key, val in attributes.items() %} | ||
| {% set _ = attributesDefault.update(attributes) %} | ||
| {% endfor %}{% endif -%} | ||
| {% set attributeString = [] %} | ||
| {% for key, val in attributesDefault.items() %} | ||
| {%- set _ = attributeString.append('%s="%s"' % (key, val)) %} | ||
| {% endfor %} | ||
| {% set attributeString = attributeString | join(" ") -%} | ||
| <a {{ attributeString }}> | ||
| {%- if type == "fontawesome" -%} | ||
| <span><i class="{{ icon }} fa-lg" aria-hidden="true"></i></span> | ||
| <span class="sr-only">{{ name }}</span> | ||
| {%- elif type == "local" -%} | ||
| <img src="{{ pathto(icon, 1) }}" class="icon-link-image" alt="{{ name }}"/> | ||
| {%- elif type == "url" -%} | ||
| <img src="{{ icon }}" class="icon-link-image" alt="{{ name }}"/> | ||
| {%- else %} | ||
| <span>Incorrectly configured icon link. Type must be `fontawesome`, `url` or `local`.</span> | ||
| {%- endif -%} | ||
| </a> | ||
| </li> | ||
| {%- endif -%} | ||
| {%- endmacro -%} | ||
| {%- if theme_icon_links -%} | ||
| <ul class="navbar-icon-links navbar-nav" | ||
| aria-label="{{ theme_icon_links_label }}"> | ||
| <li class="nav-item"> | ||
| <a href="https://aiida.net/"> | ||
| <img src="{{ pathto('_static/logo_aiida.svg', 1) }}" alt="AiiDA" class="aiida-sidebar-logo"> | ||
| </a> | ||
| </li> | ||
| {%- for icon_link in theme_icon_links -%} | ||
| {{ icon_link_nav_item(icon_link["url"], icon_link["icon"], icon_link["name"], icon_link.get("type", "fontawesome"), icon_link.get("attributes", {})) -}} | ||
| {%- endfor %} | ||
| </ul> | ||
| {%- endif -%} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <nav class="bd-links" id="bd-docs-nav" aria-label="Main"> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| {% if theme_home_page_in_toc == True %} | ||
| {#- This mimicks the pydata theme list style so we can append an extra item at the top #} | ||
| <ul class="nav bd-sidenav bd-sidenav__home-link"> | ||
| <li class="toctree-l1{% if pagename == root_doc %} current active{% endif %}"> | ||
| <a class="reference internal" href="{{ pathto(root_doc) }}"> | ||
| {{ root_title }} | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| {% endif -%} | ||
|
|
||
| {# Ref: https://github.com/pydata/pydata-sphinx-theme/blob/ebf7f704879a1cdc6016d6111062103353ac7677/src/pydata_sphinx_theme/__init__.py#L302 #} | ||
| {{- generate_toctree_html( | ||
| startdepth=0, | ||
| kind="sidebar", | ||
| maxdepth=2, | ||
| collapse=False, | ||
| includehidden=True, | ||
| titles_only=True, | ||
| show_nav_level=theme_show_navbar_depth) }} | ||
| </div> | ||
| </nav> |
Oops, something went wrong.