From c7db512af93c5a54c28bdd4ff5603fc69399fe86 Mon Sep 17 00:00:00 2001 From: Fane Shala <160877142+faneshala@users.noreply.github.com> Date: Wed, 29 May 2024 20:46:21 +0200 Subject: [PATCH] Delete docs/source directory --- docs/source/_static/.gitkeep | 0 docs/source/conf.py | 96 ------------------------------------ docs/source/index.md | 15 ------ 3 files changed, 111 deletions(-) delete mode 100644 docs/source/_static/.gitkeep delete mode 100644 docs/source/conf.py delete mode 100644 docs/source/index.md diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index f9241a7..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,96 +0,0 @@ -"""Sphinx configuration.""" - -# This file is execfile()d with the current directory set to its containing dir. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import os -import shutil -import sys -from importlib.metadata import metadata - -# -- Path setup - -__location__ = os.path.dirname(__file__) - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.join(__location__, "../../src")) - -# -- Run sphinx-apidoc -# This hack is necessary since RTD does not issue `sphinx-apidoc` before running -# `sphinx-build -b html . _build/html`. See Issue: -# https://github.com/readthedocs/readthedocs.org/issues/1139 -# DON'T FORGET: Check the box "Install your project inside a virtualenv -# Additionally it helps us to avoid running apidoc manually - -try: # for Sphinx >= 1.7 - from sphinx.ext import apidoc -except ImportError: - from sphinx import apidoc - -output_dir = os.path.join(__location__, "api") -module_dir = os.path.join(__location__, "../../src/chembalancer") -try: - shutil.rmtree(output_dir) -except FileNotFoundError: - pass - -try: - import sphinx - - cmd_line = f"sphinx-apidoc --implicit-namespaces -f -o {output_dir} {module_dir}" - - args = cmd_line.split(" ") - if tuple(sphinx.__version__.split(".")) >= ("1", "7"): - # This is a rudimentary parse_version to avoid external dependencies - args = args[1:] - - apidoc.main(args) -except Exception as e: - print(f"Running `sphinx-apidoc` failed!\n{e}") - -# -- Project information - -_metadata = metadata("ChemBalancer") - -project = _metadata["Name"] -author = _metadata["Author-email"].split("<", 1)[0].strip() -copyright = f"2024, {author}" - -version = _metadata["Version"] -release = ".".join(version.split(".")[:2]) - - -# -- General configuration - -extensions = [ - "myst_parser", - "sphinx_copybutton", - "sphinx.ext.autodoc", - "sphinx.ext.intersphinx", - "sphinx.ext.viewcode", -] - -templates_path = ["_templates"] - -exclude_patterns = [ - "Thumbs.db", - ".DS_Store", - ".ipynb_checkpoints", -] - -suppress_warnings = [ - 'myst.header' -] - -# -- Options for HTML output - -html_theme = "furo" -html_static_path = ["_static"] diff --git a/docs/source/index.md b/docs/source/index.md deleted file mode 100644 index 5266886..0000000 --- a/docs/source/index.md +++ /dev/null @@ -1,15 +0,0 @@ -```{include} ../../README.md -:relative-images: -``` - -```{toctree} -:caption: 'Contents:' -:maxdepth: 2 -api/modules -``` - -# Indices and tables - -- {ref}`genindex` -- {ref}`modindex` -- {ref}`search`