🔧 MAINT: Rename doc to docs

Author: choldgraf

.circleci/config.yml

@@ -18,7 +18,7 @@ jobs:
             - cache-pip
       # Install the packages needed to build our documentation
       # This will depend on your particular package!
-      - run: pip install --user -r doc/requirements.txt
+      - run: pip install --user -r docs/requirements.txt
       - run: pip install --user .
       # Cache some files for a speedup in subsequent builds
       - save_cache:
@@ -33,7 +33,7 @@ jobs:
             make html
       # Tell Circle to store the documentation output in a folder that we can access later
       - store_artifacts:
-          path: doc/_build/html/
+          path: docs/_build/html/
           destination: html
 
 # Tell CircleCI to use this workflow when it builds the site

.github/workflows/integration.yml

@@ -61,11 +61,11 @@ jobs:
         python -m pip install --upgrade pip
         git submodule update --init
         pip install -e .
-        pip install -r doc/requirements.txt
+        pip install -r docs/requirements.txt
 
     - name: Build docs
       run: |
-        cd doc
+        cd docs
         make html
 
   publish:

MANIFEST.in

@@ -1,2 +1,2 @@
-graft doc/
-prune doc/_build
+graft docs/
+prune docs/_build

README.md

@@ -6,7 +6,7 @@ A small sphinx extension to add a "copy" button to code blocks.
 
 See [the sphinx-copybutton documentation](https://sphinx-copybutton.readthedocs.io/en/latest/) for more details!
 
-![](doc/_static/copybutton.gif)
+![](docs/_static/copybutton.gif)
 
 ## Installation
 

doc/Makefile renamed to docs/Makefile

@@ -72,9 +72,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+# html_theme = "alabaster"
 # html_theme = "sphinx_rtd_theme"
-# html_theme = "sphinx_book_theme"
+html_theme = "sphinx_book_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

doc/_static/copybutton.gif renamed to docs/_static/copybutton.gif

@@ -1,5 +1,6 @@
 sphinx
 ipython
+sphinx-book-theme
 
 # Install ourselves
 .

doc/_static/test/TEST_COPYBUTTON.png renamed to docs/_static/test/TEST_COPYBUTTON.png

@@ -1,5 +1,5 @@
 name: sphinx-copybutton
 type: sphinx
-requirements_file: doc/requirements.txt
+requirements_file: docs/requirements.txt
 python:
   version: 3