Commit 65aa4965 authored by Qusai Al Shidi's avatar Qusai Al Shidi 💬
Browse files

Web docs

parent cf4b7055
# Configuration file for the Sphinx documentation builder.
#
# 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
# -- Path setup --------------------------------------------------------------
# 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.
#
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'swmfpy'
copyright = '2020, Qusai Al Shidi'
author = 'Qusai Al Shidi'
# The full version, including alpha/beta/rc tags
release = '0.0.1'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
.. swmfpy documentation master file, created by
sphinx-quickstart on Thu Feb 20 11:27:29 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to swmfpy's documentation!
==================================
.. toctree::
:maxdepth: 2
:caption: Contents:
swmfpy.io <swmfpy/io>
swmfpy.paramin <swmfpy/paramin>
.. automodule:: swmfpy
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
swmfpy.io SWMF Input/Output module
==================================
.. automodule:: swmfpy.io
swmfpy.paramin: Tools to manipulate PARAM.in files
==================================================
.. automodule:: swmfpy.paramin
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment