Setup rtd-testing branch for RTD redirect of carsus (#136)

* Changed version & removed extensions from conf.py * Update env file to v3 & minimized dependencies * Setup .readthedocs.yml for configuring * Added doc has moved to index page * Delete macroatom.rst * Delete model.rst * Delete api.rst * Delete kurucz_chianti_h_he.ipynb * Delete nist_weights_comp.ipynb * Delete quickstart.ipynb * Delete atomic_schema.png * Delete io_base_inheritance.png * Delete io_nist_inheritance.png
tardis-sn · Jul 12, 2019 · 076cedf · 076cedf
1 parent 2410b8d
commit 076cedf
Show file tree

Hide file tree

Showing 15 changed files with 33 additions and 1,601 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,2 @@
+conda:
+  file: carsus_ci/carsus_rtd_env3.yml
diff --git a/carsus_ci/carsus_rtd_env27.yml b/carsus_ci/carsus_rtd_env27.yml
diff --git a/carsus_ci/carsus_rtd_env3.yml b/carsus_ci/carsus_rtd_env3.yml
@@ -0,0 +1,23 @@
+name: carsus-ci
+
+channels:
+    - conda-forge
+
+dependencies:
+- python=3
+- astropy
+
+# RTD requirements
+- sphinx
+- nbconvert
+- numpydoc
+- docutils
+- nbformat
+- nbsphinx
+- sphinx_bootstrap_theme
+- sphinxcontrib-bibtex
+
+# pip packages
+- pip:
+  - git+https://github.com/tardis-sn/tardis
+  - sphinxcontrib-tikz
diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -52,22 +52,12 @@
 
 import sphinx_bootstrap_theme
 
-extensions = [
-    'sphinx.ext.autodoc',
-    'numpydoc',
-    'nbsphinx',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.graphviz'
-]
+extensions = []
 
 source_suffix = '.rst'
 ## get's rid of many toctree contains errors: see https://github.com/phn/pytpm/issues/3#issuecomment-12133978
 numpydoc_show_class_members = False
-extensions += ['matplotlib.sphinxext.plot_directive',
-               'sphinxcontrib.bibtex']
+extensions += []
 
 
 # -- General configuration ----------------------------------------------------
@@ -103,9 +93,9 @@
 
 import carsus
 # The short X.Y version.
-version = carsus.__version__.split('-', 1)[0]
+version = '-moved-documentation'
 # The full version, including alpha/beta/rc tags.
-release = carsus.__version__
+release = '-moved-documentation'
 
 
 # -- Options for HTML output ---------------------------------------------------

diff --git a/docs/images/atomic_schema.png b/docs/images/atomic_schema.png
diff --git a/docs/images/io_base_inheritance.png b/docs/images/io_base_inheritance.png
diff --git a/docs/images/io_nist_inheritance.png b/docs/images/io_nist_inheritance.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,25 +1,5 @@
-Carsus
-======
-Carsus is a TARDIS support package for creating and working with atomic datasets
+################################
+THE DOCUMENTATION HAS MOVED!!!!
+################################
 
-See the :ref:`notebooks/quickstart.ipynb` for a short introduction.
-
-Supported data sources:
------------------------
-
-    - :ref:`notebooks/nist_weights_comp.ipynb`
-
-For more information about how to use this package, see the :ref:`api`.
-
-
-Contents:
-
-.. toctree::
-    :maxdepth: 1
-
-    notebooks/quickstart.ipynb
-    notebooks/nist_weights_comp.ipynb
-    api
-    model
-    macroatom
-    notebooks/kurucz_chianti_h_he.ipynb
+See `<https://tardis-sn.github.io/carsus>`_
diff --git a/docs/macroatom.rst b/docs/macroatom.rst
diff --git a/docs/model.rst b/docs/model.rst