Skip to content

Commit 84a3ee3

Browse files
authored
Merge pull request #706 from ImperialCollegeLondon/705-remove-sphinx-tabs-and-use-sphinx-design
Replacing `sphinx-tabs` with `sphinx-design`
2 parents 2a33090 + 1124a54 commit 84a3ee3

4 files changed

Lines changed: 32 additions & 38 deletions

File tree

docs/source/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@
101101
"sphinx_external_toc",
102102
"sphinx_design",
103103
"hoverxref.extension",
104-
"sphinx_tabs.tabs",
105104
]
106105
autodoc_default_flags = ["members"]
107106
autosummary_generate = True

docs/source/using_the_ve/getting_started.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,35 +55,51 @@ first need to install the data to a location of your choice. The command below w
5555
create the `ve_example` directory at the location you choose and install all of the
5656
configuration and data files to run a model.
5757

58-
````{tabs}
59-
```{group-tab} macOS/Linux
60-
```shell
61-
ve_run --install-example /path/
58+
`````{tab-set}
59+
:sync-group: operating_system
60+
61+
````{tab-item} macOS/Linux
62+
:sync: macoslinux
63+
64+
```{code-block} shell
65+
ve_run --install-example /path/
6266
```
67+
````
6368
64-
```{group-tab} Windows
65-
```powershell
66-
ve_run --install-example C:\path\
69+
````{tab-item} Windows
70+
:sync: windows
6771
72+
```{code-block} powershell
73+
ve_run --install-example C:\path\
74+
```
6875
````
76+
`````
6977

7078
You can then run the model itself:
7179

72-
````{tabs}
73-
```{group-tab} macOS/Linux
74-
```shell
75-
ve_run /path/ve_example/config \
80+
`````{tab-set}
81+
:sync-group: operating_system
82+
83+
````{tab-item} macOS/Linux
84+
:sync: macoslinux
85+
86+
```{code-block} shell
87+
ve_run /path/ve_example/config \
7688
--outpath /path/ve_example/out \
7789
--logfile /path/ve_example/out/ve_example.log
7890
```
91+
````
92+
93+
````{tab-item} Windows
94+
:sync: windows
7995
80-
```{group-tab} Windows
81-
```powershell
82-
ve_run C:\path\ve_example\config `
96+
```{code-block} powershell
97+
ve_run C:\path\ve_example\config `
8398
--outpath C:\path\ve_example\out `
8499
--logfile C:\path\ve_example\out\ve_example.log
85100
```
86101
````
102+
`````
87103

88104
The [Virtual Ecosystem in use](virtual_ecosystem_in_use.md) page provides a walkthrough
89105
of this process, showing the typical outputs of the model run process, and also provides

poetry.lock

Lines changed: 2 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,6 @@ sphinx-rtd-theme = ">=2,<4"
8484
sphinxcontrib-bibtex = "^2.6.1"
8585
sphinxcontrib-mermaid = ">=0.9.2,<1.1.0"
8686
sphinx-hoverxref = "^1.4.1"
87-
sphinx-tabs = "^3.4.7"
8887

8988
[build-system]
9089
build-backend = "poetry.core.masonry.api"

0 commit comments

Comments
 (0)