Merge pull request #2 from kmlefran/docs

Update documentation format and content

.github/workflows/ci.yml

@@ -126,22 +126,3 @@ jobs:
     #   uses: codecov/codecov-action@v3
     #   env:
     #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-  docs:
-    runs-on: ubuntu-latest
-    timeout-minutes: 15
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.10"
-    - name: Install python dependencies
-      run: |
-        pip install --upgrade pip
-        pip install -e .[docs]
-        pip install subproptools
-        pip install group_decomposition
-        pip install pymatgen
-    - name: Build docs
-      run: cd docs && make

.readthedocs.yml

@@ -17,6 +17,7 @@ build:
 
 python:
   install:
-    - requirements: docs/requirements.txt
     - method: pip
       path: .
+      extra_requirements:
+        - docs

docs/source/_static/aiida-custom.css

@@ -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;
+}