Skip to content

Commit 13ffb19

Browse files
authored
Devops: Fix the ReadTheDocs build (#337)
* Fix the configuration to specify OS * Update Python requirement to 3.9 * Update other requirements, such as `sphinx` * Replace abandoned `sphinx-panels` with `sphinx-design` * Remove `load_profile` from sphinx extension
1 parent 0743c3a commit 13ffb19

File tree

5 files changed

+36
-32
lines changed

5 files changed

+36
-32
lines changed

.readthedocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
version: 2
22

33
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: '3.9'
47
apt_packages:
58
- gfortran # This is necessary for the `sisl` dependency of `aiida-siesta`
69

710
python:
8-
version: 3.8
911
install:
1012
- method: pip
1113
path: .

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
# -- Project information -----------------------------------------------------
1818

19-
project = 'AiiDA common workflows (ACWF)'
19+
project = 'ACWF'
2020
copyright = 'The AiiDA team.'
2121
author = 'The AiiDA team'
2222

@@ -28,7 +28,7 @@
2828
# Add any Sphinx extension module names here, as strings. They can be
2929
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3030
# ones.
31-
extensions = ['sphinx_copybutton', 'sphinx_panels', 'aiida.sphinxext', 'aiida_common_workflows.utils.sphinx_extension']
31+
extensions = ['sphinx_copybutton', 'sphinx_design', 'aiida.sphinxext', 'aiida_common_workflows.utils.sphinx_extension']
3232

3333
# Add any paths that contain templates here, relative to this directory.
3434
templates_path = ['_templates']

docs/source/index.rst

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,35 +23,43 @@ In addition to the common interface, the workflows provide input generators that
2323

2424
The common workflows can be subdivided into two categories:
2525

26+
.. grid:: 1 2 2 2
27+
:gutter: 2
2628

27-
.. panels::
28-
:body: bg-light text-center
29-
:footer: bg-light border-0
29+
.. grid-item-card:: :fa:`cogs;mr-1` **Base common workflows**
30+
:text-align: center
31+
:shadow: md
3032

33+
Workflows for basic material properties that define a common interface and are implemented for various quantum engines.
3134

32-
:fa:`cogs,mr-1` **Base common workflows**
35+
+++++++++++++++++++++++++++++++++++++++++++++
3336

34-
Workflows for basic material properties that define a common interface and are implemented for various quantum engines.
37+
.. button-ref:: workflows/base/index
38+
:ref-type: doc
39+
:click-parent:
40+
:expand:
41+
:color: primary
42+
:outline:
3543

36-
+++++++++++++++++++++++++++++++++++++++++++++
44+
To the base workflows
3745

38-
.. link-button:: workflows/base/index
39-
:type: ref
40-
:text: To the base workflows
41-
:classes: btn-outline-primary btn-block stretched-link
46+
.. grid-item-card:: :fa:`sitemap;mr-1` **Composite common workflows**
47+
:text-align: center
48+
:shadow: md
4249

43-
----------------------------------------------
50+
Higher-level workflows that reuse base common workflows in order to maintain the common interface.
4451

45-
:fa:`sitemap,mr-1` **Composite common workflows**
52+
+++++++++++++++++++++++++++++++++++++++++++++
4653

47-
Higher-level workflows that reuse base common workflows in order to maintain the common interface.
54+
.. button-ref:: workflows/composite/index
55+
:ref-type: doc
56+
:click-parent:
57+
:expand:
58+
:color: primary
59+
:outline:
4860

49-
+++++++++++++++++++++++++++++++++++++++++++++
61+
To the composite workflows
5062

51-
.. link-button:: workflows/composite/index
52-
:type: ref
53-
:text: To the composite workflows
54-
:classes: btn-outline-primary btn-block stretched-link
5563

5664

5765
.. _how-to-submit:

pyproject.toml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,11 @@ requires-python = '>=3.9'
6666

6767
[project.optional-dependencies]
6868
docs = [
69-
'docutils~=0.15.2',
70-
'pygments~=2.5',
71-
'pydata-sphinx-theme~=0.4.0',
72-
'sphinx~=3.2',
73-
'sphinx-panels~=0.5.0',
74-
'sphinxcontrib-details-directive~=0.1.0',
75-
'sphinx-copybutton~=0.3.0'
69+
'pydata-sphinx-theme~=0.14.3',
70+
'sphinx~=7.2',
71+
'sphinx-copybutton~=0.5.0',
72+
'sphinx-design~=0.5.0',
73+
'sphinxcontrib-details-directive~=0.1.0'
7674
]
7775
pre-commit = [
7876
'pre-commit~=3.6'

src/aiida_common_workflows/utils/sphinx_extension/input_generator.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
from aiida.common.utils import get_object_from_string
66
from aiida.engine import Process
7-
from aiida.manage.configuration import load_profile
87
from docutils import nodes
98
from docutils.parsers.rst import directives
109
from plumpy.ports import PortNamespace
@@ -56,9 +55,6 @@ def initialize(self):
5655
5756
Includes importing the process class.
5857
"""
59-
60-
load_profile()
61-
6258
self.class_name = self.arguments[0].split('(')[0]
6359
self.module_name = self.options['module']
6460
self.process_name = f'{self.module_name}.{self.class_name}'

0 commit comments

Comments
 (0)