more theme cleanup

.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - 'main'
+      - '*.*'
+    tags:
+      - 'v*'
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  core:
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
+    with:
+      toxdeps: tox-pypi-filter
+      envs: |
+        - linux: py312
+          libraries:
+            apt:
+              - libboost-all-dev
+      coverage: 'codecov'
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  tests:
+    needs: [core]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
+    with:
+      toxdeps: tox-pypi-filter
+      envs: |
+        - macos: py311
+          libraries:
+            brew:
+              - boost
+        - windows: py310
+          libraries:
+            choco:
+              - boost-msvc-14.3
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  docs:
+    needs: [tests]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
+    with:
+      toxdeps: tox-pypi-filter
+      envs: |
+        - linux: build_docs-gallery
+          python-version: '3.12'
+          libraries:
+            apt:
+              - libboost-all-dev
+
+
+  publish:
+    # Build wheels when pushing to any branch except main
+    # publish.yml will only publish if tagged ^v.*
+    if: |
+      (
+        github.event_name != 'pull_request' && (
+          github.ref_name != 'main' ||
+          github.event_name == 'workflow_dispatch'
+        )
+      ) || (
+        github.event_name == 'pull_request' &&
+        contains(github.event.pull_request.labels.*.name, 'Run publish')
+      )
+    needs: [tests]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@main
+    with:
+      test_extras: 'dev'
+      test_command: 'pytest -p no:warnings --doctest-rst --pyargs ebtelplusplus'
+      targets: |
+        - linux
+        - macos
+        - windows
+    secrets:
+      pypi_token: ${{ secrets.PYPI_TOKEN }}

docs/conf.py

@@ -77,6 +77,43 @@
 # a list of builtin themes.
 html_theme = "pydata_sphinx_theme"
 
+html_theme_options = {
+    "use_edit_page_button": True,
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/rice-solar-physics/ebtelplusplus",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/ebtelplusplus/",
+            "icon": "fa-brands fa-python",
+        },
+    ],
+}
+html_context = {
+    "github_user": "rice-solar-physics",
+    "github_repo": "ebtelplusplus",
+    "github_version": "main",
+    "doc_path": "docs",
+}
+# Sidebar removal
+html_sidebars = {
+    "bibliography*": [],
+    "development*": [],
+}
+# Render inheritance diagrams in SVG
+graphviz_output_format = "svg"
+graphviz_dot_args = [
+    '-Nfontsize=10',
+    '-Nfontname=Helvetica Neue, Helvetica, Arial, sans-serif',
+    '-Efontsize=10',
+    '-Efontname=Helvetica Neue, Helvetica, Arial, sans-serif',
+    '-Gfontsize=10',
+    '-Gfontname=Helvetica Neue, Helvetica, Arial, sans-serif'
+]
+
 # -- Other options ----------------------------------------------------------
 bibtex_bibfiles = ['references.bib']
 

docs/development.rst

@@ -40,12 +40,12 @@ To verify that you have a working installation, you can run the test suite,
 
 .. code:: shell
 
-    pytest ebtelplusplus
+    $ pytest ebtelplusplus
 
 You are now ready to start contributing to or modifying ``ebtelplusplus``.
 Note that if you are modifying any of the simulation code, that is contained in ``ebtelplusplus/extern`` and is implemented in C++.
 After each change, you will need to recompile using the above installation command.
 
-For more information about proposing new changes back to the main repository, see `this section of the SunPy newcomer's guide <https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html#send-it-back-to-us>`.
+For more information about proposing new changes back to the main repository, see `this section of the SunPy newcomer's guide <https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html#send-it-back-to-us>`__.
 
 .. _ebtelplusplus: https://github.com/rice-solar-physics/ebtelPlusPlus