Switch documentation to Documenter, part 2 (#184)

* Switch docs links in README to the Documenter version on github.io * Replace RST docs with pointer to new Documenter based docs
JuliaDSP · Oct 16, 2017 · 6604d4c · 6604d4c
1 parent b0994fe
commit 6604d4c
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 623 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ DSP.jl
 
 DSP.jl provides a number of common DSP routines in Julia.  So far, the following are implemented:
 
-- [Periodogram estimation](http://dspjl.readthedocs.org/en/latest/periodograms.html)
-- [Window functions](http://dspjl.readthedocs.org/en/latest/windows.html)
-- [Filter design and filtering](http://dspjl.readthedocs.org/en/latest/filters.html)
-- [Utility functions](http://dspjl.readthedocs.org/en/latest/util.html)
+- [Periodogram estimation](https://juliadsp.github.io/DSP.jl/latest/periodograms.html)
+- [Window functions](https://juliadsp.github.io/DSP.jl/latest/windows.html)
+- [Filter design and filtering](https://juliadsp.github.io/DSP.jl/latest/filters.html)
+- [Utility functions](https://juliadsp.github.io/DSP.jl/latest/util.html)
diff --git a/doc/conf.py b/doc/conf.py
@@ -25,7 +25,7 @@
 
 # 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.pngmath', 'sphinx.ext.mathjax']
+# extensions = ['sphinx.ext.pngmath', 'sphinx.ext.mathjax']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/doc/filters.rst b/doc/filters.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -3,26 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to DSP.jl's documentation!
+DSP.jl's documentation has moved!
 ==================================
 
-Contents:
-
-DSP.jl provides a number of common DSP routines in Julia. So far, the following submodules are implemented:
-
-.. toctree::
-   :maxdepth: 2
-
-   periodograms.rst
-   windows.rst
-   filters.rst
-   util.rst
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
+Please see `the new documentation site
+<https://juliadsp.github.io/DSP.jl/latest/contents.html>`_.