From 9b6ee3deae3d0bcb9c954188cd6fe55544094994 Mon Sep 17 00:00:00 2001 From: milanofthe Date: Thu, 17 Sep 2026 09:51:49 +0200 Subject: [PATCH] Remove deprecated sphinx docs --- docs/.readthedocs.yaml | 18 ---- docs/Makefile | 20 ----- docs/make.bat | 35 -------- docs/requirements.txt | 7 -- docs/source/_autosummary/pathsim_chem.rst | 6 -- docs/source/_static/custom.css | 64 ------------- docs/source/api.rst | 20 ----- docs/source/conf.py | 104 ---------------------- docs/source/index.rst | 34 ------- docs/source/modules/tritium.rst | 17 ---- pyproject.toml | 9 +- 11 files changed, 1 insertion(+), 333 deletions(-) delete mode 100644 docs/.readthedocs.yaml delete mode 100644 docs/Makefile delete mode 100644 docs/make.bat delete mode 100644 docs/requirements.txt delete mode 100644 docs/source/_autosummary/pathsim_chem.rst delete mode 100644 docs/source/_static/custom.css delete mode 100644 docs/source/api.rst delete mode 100644 docs/source/conf.py delete mode 100644 docs/source/index.rst delete mode 100644 docs/source/modules/tritium.rst diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml deleted file mode 100644 index 06aaa9c..0000000 --- a/docs/.readthedocs.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -version: 2 - -build: - os: ubuntu-24.04 - tools: - python: "3.13" - -sphinx: - configuration: docs/source/conf.py - -python: - install: - - method: pip - path: . - - requirements: docs/requirements.txt diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d0c3cbf..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index dc1312a..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 8a0e9b5..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -numpy>=1.15,<2 -scipy>=1.2 -sphinx>=7.0 -furo -myst-parser -sphinx-copybutton -sphinx-design diff --git a/docs/source/_autosummary/pathsim_chem.rst b/docs/source/_autosummary/pathsim_chem.rst deleted file mode 100644 index 7661d65..0000000 --- a/docs/source/_autosummary/pathsim_chem.rst +++ /dev/null @@ -1,6 +0,0 @@ -pathsim\_chem -============= - -.. automodule:: pathsim_chem - - \ No newline at end of file diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css deleted file mode 100644 index 473543b..0000000 --- a/docs/source/_static/custom.css +++ /dev/null @@ -1,64 +0,0 @@ -/* Custom CSS for PathSim-Chem Documentation */ - -/* Fix link preview card backgrounds for light/dark mode */ -.sd-card { - background-color: var(--color-card-background) !important; -} - -.sd-card-header { - background-color: var(--color-card-marginals-background) !important; -} - -.sd-card-footer { - background-color: var(--color-card-marginals-background) !important; -} - -/* Ensure link preview text is readable in both modes */ -.sd-card-text { - color: var(--color-foreground-primary) !important; -} - -.sd-card-title { - color: var(--color-foreground-primary) !important; -} - -/* Fix any link cards created by MyST linkify */ -a.reference.external .sd-card { - background-color: var(--color-card-background) !important; - border-color: var(--color-card-border) !important; -} - -/* Main tooltip container */ -.tooltip { - background-color: var(--color-background-primary) !important; - border: 1px solid var(--color-background-border) !important; - box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15) !important; -} - -/* Dark mode specific adjustments */ -body[data-theme="dark"] .tooltip { - box-shadow: 0 2px 8px rgba(0, 0, 0, 0.5) !important; -} - -/* Tooltip content text */ -.tooltip .highlight, -.tooltip pre, -.tooltip code { - background-color: var(--color-code-background) !important; - color: var(--color-code-foreground) !important; -} - -/* Tooltip general text */ -.tooltip, -.tooltip * { - color: var(--color-foreground-primary) !important; -} - -/* Tooltip links */ -.tooltip a { - color: var(--color-link) !important; -} - -.tooltip a:hover { - color: var(--color-link--hover) !important; -} diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index 505b339..0000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,20 +0,0 @@ -API Reference -============= - -The following modules form the chemical engineering toolbox for PathSim. - -.. grid:: 2 - :gutter: 3 - - .. grid-item-card:: Tritium - :link: modules/tritium - :link-type: doc - - Tritium science toolbox for nuclear fusion - - -.. toctree:: - :hidden: - :maxdepth: 3 - - modules/tritium diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index e1e0926..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,104 +0,0 @@ -""" -Configuration file for the Sphinx documentation builder. -""" - -import os -import sys - -# Add the package to the path -sys.path.insert(0, os.path.abspath('../../src')) - -# Import version -try: - from pathsim_chem import __version__ -except ImportError: - __version__ = "unknown" - -# -- Project information ----------------------------------------------------- - -project = 'pathsim-chem' -copyright = '2025, PathSim Contributors' -author = 'PathSim Contributors' -version = __version__ -release = __version__ - -# -- General configuration --------------------------------------------------- - -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.napoleon', - 'sphinx.ext.viewcode', - 'sphinx.ext.mathjax', - 'sphinx.ext.autosummary', - 'sphinx.ext.intersphinx', - 'myst_parser', - 'sphinx_copybutton', - 'sphinx_design', -] - -templates_path = ['_templates'] -exclude_patterns = [] - -# -- Options for HTML output ------------------------------------------------- - -html_theme = 'furo' -html_static_path = ['_static', 'logos'] -html_css_files = ['custom.css'] -html_logo = 'logos/chem_logo.png' -html_favicon = "logos/pathsim_icon.png" -html_title = "PathSim-Chem Documentation" - -html_theme_options = { - "light_css_variables": { - "color-brand-primary": "#377eb8", - "color-brand-content": "#377eb8", - "color-api-keyword": "#377eb8", - "color-highlight-on-target": "#fff3cd", - }, - "dark_css_variables": { - "color-brand-primary": "#377eb8", - "color-brand-content": "#377eb8", - "color-api-keyword": "#377eb8", - "color-highlight-on-target": "#fff3cd", - }, - "sidebar_hide_name": True, - "navigation_with_keys": True, - "top_of_page_button": "edit", - "source_repository": "https://github.com/pathsim/pathsim-chem", - "source_branch": "main", - "source_directory": "docs/source/", -} - -# -- Extension configuration ------------------------------------------------- - -# Autodoc settings -autodoc_default_options = { - 'members': True, - 'member-order': 'bysource', - 'special-members': '__init__', - 'undoc-members': True, - 'exclude-members': '__weakref__' -} - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_init_with_doc = True - -# Autosummary settings -autosummary_generate = True - -# Intersphinx mapping to link to core pathsim documentation -intersphinx_mapping = { - 'python': ('https://docs.python.org/3', None), - 'numpy': ('https://numpy.org/doc/stable/', None), - 'scipy': ('https://docs.scipy.org/doc/scipy/', None), - 'matplotlib': ('https://matplotlib.org/stable/', None), - 'pathsim': ('https://pathsim.readthedocs.io/en/latest/', None), -} - -# MyST settings -myst_enable_extensions = [ - "colon_fence", - "deflist", -] diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index 950c738..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,34 +0,0 @@ -PathSim-Chem -============ - -Chemical Engineering Blocks for PathSim. - -PathSim-Chem provides specialized blocks for chemical engineering simulations, -extending the core `PathSim `_ framework with -domain-specific functionality. - -.. raw:: html - -
- - PathSim - - - View on GitHub - - - Issue Tracker - -
- -Installation ------------- - -.. code-block:: bash - - pip install pathsim-chem - -.. toctree:: - :hidden: - - api diff --git a/docs/source/modules/tritium.rst b/docs/source/modules/tritium.rst deleted file mode 100644 index 980f635..0000000 --- a/docs/source/modules/tritium.rst +++ /dev/null @@ -1,17 +0,0 @@ -tritium -======= - -.. automodule:: pathsim_chem.tritium.splitter - :members: - :show-inheritance: - :undoc-members: - -.. automodule:: pathsim_chem.tritium.residencetime - :members: - :show-inheritance: - :undoc-members: - -.. automodule:: pathsim_chem.tritium.bubbler - :members: - :show-inheritance: - :undoc-members: diff --git a/pyproject.toml b/pyproject.toml index 0ef765f..b57a7f3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,17 +41,10 @@ test = [ "pytest>=7.0", "pytest-cov>=4.0", ] -docs = [ - "sphinx>=7.0", - "furo", - "myst-parser", - "sphinx-copybutton", - "sphinx-design", -] [project.urls] Homepage = "https://github.com/pathsim/pathsim-chem" -Documentation = "https://pathsim-chem.readthedocs.io" +Documentation = "https://docs.pathsim.org/chem" Repository = "https://github.com/pathsim/pathsim-chem" Issues = "https://github.com/pathsim/pathsim-chem/issues"