Skip to content

Commit

Permalink
v1.8.1 (#307)
Browse files Browse the repository at this point in the history
Replace sphinx-panels by sphinx-design.
  • Loading branch information
prisae authored Oct 15, 2022
1 parent 8bd81c4 commit 4053fbb
Show file tree
Hide file tree
Showing 11 changed files with 226 additions and 178 deletions.
12 changes: 10 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ Changelog
""""""""""


*latest*
--------
v1.8.1 : Bugfix ellipse
-----------------------

**2022-10-15**


- Small improvements to the ellipse-function (and the CLI):
Expand All @@ -16,6 +18,12 @@ Changelog
- A radius of 0.0 provided through the CLI is now respected (was before
overwritten).

- ``empymod`` is more verbose when using ``layered`` computations.

- Maintenance:

- Replace deprecated ``sphinx-panels`` with ``sphinx-design``.


v1.8.0 : Layered modelling
--------------------------
Expand Down
14 changes: 7 additions & 7 deletions docs/_static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@

/* Button colours */

.btn-info {
.sd-btn-info {
font-weight: bold;
background: #447fc1;
border-color: #447fc1;
background: #447fc1 !important;
border-color: #447fc1 !important;
}

.btn-info:hover {
background: #ef413d;
border-color: #ef413d;
.sd-btn-info:hover {
background: #ef413d !important;
border-color: #ef413d !important;
}

/* Card headers */
.card-header {
.sd-card-header {
font-size: var(--pst-font-size-h5);
font-weight: bold;
padding: 1rem 2rem;
Expand Down
34 changes: 15 additions & 19 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,33 +29,29 @@ API reference
utils


.. panels::
:container: container-lg pb-1
:column: col-lg-12 p-2
.. grid:: 1
:gutter: 2

Grid: :class:`emg3d.meshes.TensorMesh`
.. grid-item-card::

---
:column: col-lg-12 p-2
Grid: :class:`emg3d.meshes.TensorMesh`

Model: :class:`emg3d.models.Model`
.. grid-item-card::

---
:column: col-lg-12 p-2
Model: :class:`emg3d.models.Model`

Survey: :class:`emg3d.surveys.Survey`
.. grid-item-card::

---
:column: col-lg-12 p-2
Survey: :class:`emg3d.surveys.Survey`

Simulation: :class:`emg3d.simulations.Simulation`
.. grid-item-card::

---
:column: col-lg-12 p-2
Simulation: :class:`emg3d.simulations.Simulation`

Solver: :func:`emg3d.solver.solve`
.. grid-item-card::

---
:column: col-lg-12 p-2
Solver: :func:`emg3d.solver.solve`

All sources and receivers are in :mod:`emg3d.electrodes`
.. grid-item-card::

All sources and receivers are in :mod:`emg3d.electrodes`
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
extensions = [
# 'sphinx.ext.autodoc',
'numpydoc',
'sphinx_panels',
'sphinx_design',
'sphinx.ext.intersphinx',
# 'sphinx.ext.autosummary',
'sphinx.ext.mathjax',
Expand All @@ -19,7 +19,6 @@
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
]
panels_add_bootstrap_css = False
autosummary_generate = True
add_module_names = True
add_function_parentheses = False
Expand Down
64 changes: 39 additions & 25 deletions docs/dev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,39 +18,53 @@ Development
maintenance
release

.. panels::
:container: container-lg pb-2 text-center
.. grid:: 1 2 2 2
:gutter: 2

:fa:`code,fa-4x`
.. grid-item-card::
:text-align: center

.. link-button:: contributing
:type: ref
:text: Contributing
:classes: btn-link stretched-link font-weight-bold
:fa:`code;fa-4x`

---
.. button-ref:: contributing
:expand:
:color: info
:click-parent:

:fa:`fas fa-hourglass-half,fa-4x`
Contributing

.. link-button:: tests
:type: ref
:text: Tests & Benchmarks
:classes: btn-link stretched-link font-weight-bold
.. grid-item-card::
:text-align: center

---
:fa:`fas fa-hourglass-half;fa-4x`

:fa:`cogs,fa-4x`
.. button-ref:: tests
:expand:
:color: info
:click-parent:

.. link-button:: maintenance
:type: ref
:text: Maintenance
:classes: btn-link stretched-link font-weight-bold
Tests & Benchmarks

---
.. grid-item-card::
:text-align: center

:fa:`rocket,fa-4x`
:fa:`cogs;fa-4x`

.. link-button:: release
:type: ref
:text: Making a release
:classes: btn-link stretched-link font-weight-bold
.. button-ref:: maintenance
:expand:
:color: info
:click-parent:

Maintenance

.. grid-item-card::
:text-align: center

:fa:`rocket;fa-4x`

.. button-ref:: release
:expand:
:color: info
:click-parent:

Making a release
2 changes: 1 addition & 1 deletion docs/dev/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ To check the environment in which the documentation was built.
In [1]: import emg3d
...: emg3d.Report(
...: ['sphinx', 'numpydoc', 'ipykernel', 'sphinx_numfig',
...: 'sphinx_panels', 'sphinx_automodapi', 'pydata_sphinx_theme']
...: 'sphinx_design', 'sphinx_automodapi', 'pydata_sphinx_theme']
...: )
Loading

0 comments on commit 4053fbb

Please sign in to comment.