Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update sphinx theme to pydata-theme #140

Merged
merged 2 commits into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ channels:

dependencies:
- breathe
- sphinx_rtd_theme
- doxygen
- pydata-sphinx-theme
Binary file added docs/source/_static/dark_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/light_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
API
===

.. toctree::
:caption: API reference
:maxdepth: 1

algorithm
interval
box
cell
subset
35 changes: 24 additions & 11 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import sphinx_rtd_theme

# -- Project information -----------------------------------------------------

project = 'Samurai'
Expand All @@ -42,7 +40,6 @@
'sphinx.ext.todo',
'sphinx.ext.mathjax',
'breathe',
'sphinx_rtd_theme',
]

breathe_projects = { 'samurai': '../xml' }
Expand Down Expand Up @@ -72,7 +69,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand All @@ -88,15 +85,31 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = "pydata_sphinx_theme"

html_theme_options = {
"logo": {
"image_light": "_static/light_logo.png",
"image_dark": "_static/dark_logo.png",
},
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/hpc-maths/samurai",
"icon": "fa-brands fa-square-github",
"type": "fontawesome",
},
],
"primary_sidebar_end": ["sidebar-ethical-ads.html"],
}

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'collapse_navigation': False,
}
# html_theme_options = {
# 'collapse_navigation': False,
# }

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand All @@ -113,9 +126,9 @@
#
# html_sidebars = {}

html_css_files = [
'css/custom.css',
]
# html_css_files = [
# 'css/custom.css',
# ]

# -- Options for HTMLHelp output ---------------------------------------------

Expand Down
69 changes: 8 additions & 61 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
.. _topics-index:

========================
|project| documentation
========================

.. toctree::
:hidden:
:maxdepth: 1

tutorial <tutorial/index>
reference <reference/index>
api <api/index>

The main goal of |project| is to provide a new data structure based on intervals and algebra of sets to handle efficiently adaptive mesh refinement methods based on a cartesian grid. Such an approach has to be versatile enough to handle both AMR and multi-resolution methods.

Most of the existing data structures used for such a purpose are based on the construction of a tree (quadtree in 2d or octree in 3d).
Expand All @@ -20,63 +26,4 @@ In order to improve the efficiency of the tree / space-filling curve, the propos

SAMURAI: Structured Adaptive mesh and MUlti-Resolution based on Algebra of Intervals.


.. toctree::
:caption: Tutorial
:maxdepth: 1

tutorial/interval
tutorial/field
tutorial/algorithm
tutorial/operator_on_subset
tutorial/graduation
tutorial/level_set
tutorial/1d_burgers_amr

.. :doc:`tutorial/interval`

.. :doc:`tutorial/algorithm`

.. :doc:`tutorial/operator_on_subset`

.. :doc:`tutorial/graduation`

.. :doc:`tutorial/level_set`

.. :doc:`tutorial/1d_burgers_amr`

.. toctree::
:caption: Test cases
:maxdepth: 1

LBM/test_cases

.. toctree::
:caption: Reference
:maxdepth: 2

reference/subset

.. :doc:`reference/subset`

.. toctree::
:caption: API reference
:maxdepth: 2

api/algorithm
api/interval
api/box
api/cell
api/subset

.. :doc:`api/algorithm`

.. :doc:`api/interval`

.. :doc:`api/box`

.. :doc:`api/cell`

.. :doc:`api/subset`

.. _p4est: http://www.p4est.org/
Binary file added docs/source/logo/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/source/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Reference manual
================

.. toctree::
:caption: Reference
:maxdepth: 1

Algebra of set <subset>
14 changes: 14 additions & 0 deletions docs/source/tutorial/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Tutorials
=========

.. toctree::
:caption: Tutorial
:maxdepth: 1

interval
field
algorithm
operator_on_subset
graduation
level_set
1d_burgers_amr
Loading