DOC: rename doc/ to docs/ (#24)

hagenw · Aug 9, 2019 · c9a6db7 · c9a6db7
1 parent bfd1a94
commit c9a6db7
Show file tree

Hide file tree

Showing 13 changed files with 10 additions and 10 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,7 +5,7 @@ matrix:
   include:
 
   # Default Python + latest Sphinx + check for broken links
-  - env: ADDITIONAL_COMMAND="python -m sphinx doc/ doc/_build/ -b linkcheck -W"
+  - env: ADDITIONAL_COMMAND="python -m sphinx docs/ docs/_build/ -b linkcheck -W"
 
   # A few older Sphinx releases using default Python version and stripped down
   # example from tests/
@@ -32,9 +32,9 @@ install:
   - pip install sphinx$SPHINX
   - python setup.py install
 script:
-  - python -m sphinx ${FOLDER:-doc} ${FOLDER:-doc}/_build/ -c doc/ -b html -W
-  - python -m sphinx ${FOLDER:-doc} ${FOLDER:-doc}/_build/ -c doc/ -b latex -W
+  - python -m sphinx ${FOLDER:-docs} ${FOLDER:-docs}/_build/ -c docs/ -b html -W
+  - python -m sphinx ${FOLDER:-docs} ${FOLDER:-docs}/_build/ -c docs/ -b latex -W
   # Test server side prerendering
   - katex -V
-  - python -m sphinx ${FOLDER:-doc} ${FOLDER:-doc}/_build/ -c doc/ -b html -D katex_prerender=1 -W
+  - python -m sphinx ${FOLDER:-docs} ${FOLDER:-docs}/_build/ -c docs/ -b html -D katex_prerender=1 -W
   - $ADDITIONAL_COMMAND
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -37,17 +37,17 @@ If you make changes to the documentation, you can re-create the HTML pages
 using Sphinx_.
 You can install it and a few other necessary packages with::
 
-   pip install -r doc/requirements.txt
+   pip install -r docs/requirements.txt
 
 To create the HTML pages, use::
 
-   python -m sphinx doc/ build/sphinx/ -b html
+   python -m sphinx docs/ build/sphinx/ -b html
 
 The generated files will be available in the directory ``build/sphinx/``.
 
 It is also possible to automatically check if all links are still valid::
 
-   python -m sphinx doc/ build/sphinx/ -b linkcheck
+   python -m sphinx docs/ build/sphinx/ -b linkcheck
 
 .. _Sphinx: http://sphinx-doc.org/
 
@@ -57,15 +57,15 @@ Running Tests
 
 ``sphinxcontrib.katex`` is supposed to work for all versions ``sphinx>=1.6``.
 To test that you have to use a stripped down version of the documentation that
-is provided in the ``tests/`` folder, as the documentation under ``doc/`` uses
+is provided in the ``tests/`` folder, as the documentation under ``docs/`` uses
 features that are only supported by ``sphinx>=1.8``.
 
 To test that everything works as expected, please execute:
 
 .. code-block:: bash
 
-   python -m sphinx tests/ tests/_build/ -c doc/ -b html -W
-   python -m sphinx tests/ tests/_build/ -c doc/ -b latex -W
+   python -m sphinx tests/ tests/_build/ -c docs/ -b html -W
+   python -m sphinx tests/ tests/_build/ -c docs/ -b latex -W
 
 The same tests are automatically performed by Travis_ once you create a pull
 request on Github_.

diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/doc/configuration.rst → docs/configuration.rst b/doc/configuration.rst → docs/configuration.rst
diff --git a/doc/contributing.rst → docs/contributing.rst b/doc/contributing.rst → docs/contributing.rst
diff --git a/doc/definitions.py → docs/definitions.py b/doc/definitions.py → docs/definitions.py
diff --git a/doc/examples.rst → docs/examples.rst b/doc/examples.rst → docs/examples.rst
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
diff --git a/doc/installation.rst → docs/installation.rst b/doc/installation.rst → docs/installation.rst
diff --git a/doc/macros.rst → docs/macros.rst b/doc/macros.rst → docs/macros.rst
diff --git a/doc/requirements.txt → docs/requirements.txt b/doc/requirements.txt → docs/requirements.txt
diff --git a/doc/usage.rst → docs/usage.rst b/doc/usage.rst → docs/usage.rst
diff --git a/doc/version-history.rst → docs/version-history.rst b/doc/version-history.rst → docs/version-history.rst