diff --git a/.gitignore b/.gitignore index ca27393..40f0135 100644 --- a/.gitignore +++ b/.gitignore @@ -2,8 +2,8 @@ .#* *# .DS_Store -docs/ipynb/* -!docs/ipynb/*.ipynb +docs/* +!docs/*.ipynb docs/_build .cache .coverage diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index a458a7f..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,8 +0,0 @@ -version: 2 - -python: - version: 3.8 - install: - - requirements: docs/requirements.txt - - method: pip - path: . diff --git a/Makefile b/Makefile index fb866ed..2746770 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ PROJECT=micromagnetictests -IPYNBPATH=docs/ipynb/*.ipynb +IPYNBPATH=docs/*.ipynb PYTHON?=python test-unittests: diff --git a/README.md b/README.md index a093c0b..25a46d1 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ | Coverage | [![codecov](https://codecov.io/gh/ubermag/micromagnetictests/branch/master/graph/badge.svg?token=hcK4fofmrL)](https://codecov.io/gh/ubermag/micromagnetictests) | | Documentation | [![Documentation](https://img.shields.io/badge/Docs-ubermag.github.io-blue)](https://ubermag.github.io/documentation/micromagnetictests.html) | | YouTube | [![YouTube](https://img.shields.io/badge/YouTube-ubermag-blue)](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg) | -| Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ubermag/micromagnetictests/stable?urlpath=lab/tree/docs/ipynb/index.ipynb)| +| Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ubermag/micromagnetictests/stable?urlpath=lab/tree/docs/index.ipynb) | | Platforms | [![Platforms](https://anaconda.org/conda-forge/micromagnetictests/badges/platforms.svg)](https://anaconda.org/conda-forge/micromagnetictests) | | Downloads | [![Downloads](https://anaconda.org/conda-forge/micromagnetictests/badges/downloads.svg)](https://anaconda.org/conda-forge/micromagnetictests) | | License | [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) | diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d4bb2cb..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 = . -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/_templates/class-template.rst b/docs/_templates/class-template.rst deleted file mode 100644 index b33aeaa..0000000 --- a/docs/_templates/class-template.rst +++ /dev/null @@ -1,41 +0,0 @@ -{{ objname | escape | underline }} - -.. currentmodule:: {{ module }} - -.. autoclass:: {{ objname }} - :members: - :special-members: - - .. raw:: html - -
- - {% block methods %} - {% if methods %} - .. rubric:: {{ ('Methods') }} - - .. autosummary:: - :nosignatures: - {% for item in all_methods %} - {% if not item.startswith('_') or - (item.startswith('__') and item not in excluded_members) %} - ~{{ name }}.{{ item }} - {% endif %} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block attributes %} - {% if attributes %} - .. rubric:: {{ ('Properties') }} - - .. autosummary:: - {% for item in attributes %} - ~{{ name }}.{{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - - .. raw:: html - -
diff --git a/docs/_templates/module-template.rst b/docs/_templates/module-template.rst deleted file mode 100644 index 424e489..0000000 --- a/docs/_templates/module-template.rst +++ /dev/null @@ -1,53 +0,0 @@ -{{ fullname | escape | underline}} - -.. automodule:: {{ fullname }} - {% block attributes %} - {% if attributes %} - .. rubric:: Module attributes - - .. autosummary:: - :toctree: - {% for item in attributes %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block classes %} - {% if classes %} - .. rubric:: {{ ('Classes') }} - - .. autosummary:: - :toctree: - :template: class-template.rst - :nosignatures: - {% for item in classes %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block functions %} - {% if functions %} - .. rubric:: {{ ('Functions') }} - - .. autosummary:: - :toctree: - :nosignatures: - {% for item in functions %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block exceptions %} - {% if exceptions %} - .. rubric:: {{ ('Exceptions') }} - - .. autosummary:: - :toctree: - {% for item in exceptions %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 49ea4d4..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,78 +0,0 @@ -# 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 = 'micromagnetictests' -copyright = '2021, Marijan Beg and Hans Fangohr' -author = 'Marijan Beg, Martin Lang, and Hans Fangohr' - - -# -- 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', - 'sphinx.ext.autosummary', - 'sphinx.ext.napoleon', - 'sphinx.ext.mathjax', - 'nbsphinx', - 'm2r2' -] - -# 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 = 'sphinx_rtd_theme' - -# 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'] - -# Custom configuration -autosummary_generate = True -autosummary_imported_members = True -autosummary_context = { - 'excluded_members': ['__radd__', '__rand__', '__rlshift__', '__rmatmul__', - '__rmul__', '__rsub__', '__rtruediv__', '__delattr__', - '__format__', '__ge__', '__getattribute__', '__gt__', - '__init__', '__init_subclass__', '__le__', '__lt__', - '__ne__', '__new__', '__reduce__', '__reduce_ex__', - '__setattr__', '__sizeof__', '__str__', - '__subclasshook__', '__hash__'] -} - -autoclass_content = 'class' -autodoc_inherit_docstrigs = True -autodoc_default_options = { - 'member-order': 'groupwise', - 'exclude-members': '__init__, __weakref__' -} diff --git a/docs/ipynb/index.ipynb b/docs/index.ipynb similarity index 100% rename from docs/ipynb/index.ipynb rename to docs/index.ipynb diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 7464fa9..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -NEW WEBSITE: https://ubermag.github.io -====================================== - -``Micromagnetictests`` is part of the ``ubermag`` metapackage. Recently, the -websites for the different subpackages have been centralised. Please use the new -`documentation `_ -and `API reference `_ in -the future. - -You should be redirected in 5 seconds automatically. - -.. raw:: html - - diff --git a/docs/ipynb/installation-testing-update.ipynb b/docs/installation-testing-update.ipynb similarity index 100% rename from docs/ipynb/installation-testing-update.ipynb rename to docs/installation-testing-update.ipynb diff --git a/docs/ipynb/other.ipynb b/docs/other.ipynb similarity index 100% rename from docs/ipynb/other.ipynb rename to docs/other.ipynb diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index acaacf8..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -sphinx>=3.4 -nbsphinx>=0.8 -m2r2>=0.2 diff --git a/docs/ipynb/usage.ipynb b/docs/usage.ipynb similarity index 100% rename from docs/ipynb/usage.ipynb rename to docs/usage.ipynb