Merge pull request #9 from scientificcomputing/dokken/restructure-repo

Move _toc and _config to root

Author: jorgensd

.github/workflows/build_docs.yml

@@ -4,7 +4,8 @@ name: Deploy static content to Pages
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
+    branches:
+    - "**"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -51,6 +52,7 @@ jobs:
 
   # Single deploy job since we're just deploying
   deploy:
+    if: github.ref == 'refs/heads/main'
     needs: build
     environment:
       name: github-pages

hooks/post_gen_project.py

@@ -15,12 +15,12 @@
     '.github/workflows/check_formatting.yml',
     '.flake8',
     '.github/workflows/build_docs.yml',
-    'docs/_config.yml',
-    'docs/_toc.yml',
     'docs/api.rst',
-    'docs/index.md',
     'docs/logo.png',
     'docs',
+    '_config.yml',
+    '_toc.yml',
+    'index.md',
     {% endif %}
     {%- if cookiecutter.docker|lower != "y" %}
     'Dockerfile',

{{cookiecutter.repository_name}}/.github/workflows/build_docs.yml

@@ -4,7 +4,8 @@ name: Deploy static content to Pages
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
+    branches: 
+    - "**"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -22,7 +23,7 @@ concurrency:
 
 env:
   # Directory that will be published on github pages
-  PUBLISH_DIR: ./docs/_build/html
+  PUBLISH_DIR: ./_build/html
 
 jobs:
 
@@ -42,7 +43,7 @@ jobs:
         run: python3 -m pip install ".[docs]"
 
       - name: Build docs
-        run: 	jupyter book build -W docs
+        run: 	jupyter book build -W .
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
@@ -51,6 +52,7 @@ jobs:
 
   # Single deploy job since we're just deploying
   deploy:
+    if: github.ref == 'refs/heads/main'
     needs: build
     environment:
       name: github-pages

…utter.repository_name}}/docs/_config.yml …okiecutter.repository_name}}/_config.yml{{cookiecutter.repository_name}}/docs/_config.yml renamed to {{cookiecutter.repository_name}}/_config.yml {{cookiecutter.repository_name}}/docs/_config.yml renamed to {{cookiecutter.repository_name}}/_config.yml

@@ -3,7 +3,7 @@
 
 title: {{ cookiecutter.project_name }}
 author: {{ cookiecutter.full_name }}
-logo: "logo.png"
+logo: "docs/logo.png"
 copyright: "{% now 'utc', '%Y' %}"
 
 # Force re-execution of notebooks on each build.
@@ -30,4 +30,6 @@ sphinx:
   extra_extensions:
   - 'sphinx.ext.autodoc'
   - 'sphinx.ext.napoleon'
-  - 'sphinx.ext.viewcode'
+  - 'sphinx.ext.viewcode'
+
+exclude_patterns: ["README.md",] 

…iecutter.repository_name}}/docs/_toc.yml {{cookiecutter.repository_name}}/_toc.yml{{cookiecutter.repository_name}}/docs/_toc.yml renamed to {{cookiecutter.repository_name}}/_toc.yml {{cookiecutter.repository_name}}/docs/_toc.yml renamed to {{cookiecutter.repository_name}}/_toc.yml

@@ -4,4 +4,4 @@ root: index
 parts:
   - caption: Python API
     chapters:
-    - file: "api"
+    - file: "docs/api"