Reorganize and update documentation (#5059)

* Getting docs ready for v4 example doc restructure working and hopefully illustrative doc skeleton update requirements WIP Change log: - Upload new PyMC logo - Updated conf.py to pymc instead of pymc3 - Start configuring and populating index page - Start configuring and populating learning page - Start configuring and populating api page - Updated API to follow the docs/Architecture.png layout - Start configuring and populating learning page - Fix typo in filename of "index legacy" add community page, other minor changes Continue restructuring the API Delete conflicting files example doc restructure update requirements update requirements and gitignore some fixes add changes introduced by pre-commit checks fix community page title update api for distributions update gaussian process api fix end of file more changes sponsor logos sponsor logos cleanup, other changes changes to satisfy pre-commit checks requirements changes minor changes Add testimonials to docs homepage remove sphinx panels and other changes center buttons add explanation of MAP to glassor minor change fix typo minor changes put content in videos and podcasts section. Change formatting of testimonials (width of 2 cards for better formating in narrow screens) add code example to front page revise some definitions (#5126) minor changes minor changes WIP: organizing notebooks into learning section * add style guides * remove multilevel modeling * formatting the learning section * add anchors to notebooks * add anchors to all the main pages for easy intra-doc linking * Changelog - Add information for institutions in the Contributing section - Center navbar - Split the About section into a main page with multiple subpages - Remove old reference to "developers" in the index toctree * fix anchor for Advanced_usage_of_Aesara_in_PyMC.rst Co-authored-by: Oriol Abril-Pla <oriol.abril.pla@gmail.com> * redoing the community page after it got lost in a force push * minor changes * update code example * redo community page * try twitter feed on sidebar * restructure contributing docs * fix requirements * Apply suggestions from code review Co-authored-by: Martina Cantaro <6120897+martinacantaro@users.noreply.github.com>
pymc-devs · Nov 24, 2021 · 99ec0ff · 99ec0ff
1 parent b8522dc
commit 99ec0ff
Show file tree

Hide file tree

Showing 78 changed files with 7,181 additions and 1,726 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,6 +17,7 @@ tags
 
 # Sphinx
 _build
+docs/jupyter_execute
 
 # Merge tool
 *.orig

diff --git a/.gitmodules b/.gitmodules
diff --git a/conda-envs/environment-dev-py37.yml b/conda-envs/environment-dev-py37.yml
@@ -23,9 +23,8 @@ dependencies:
 - python-graphviz
 - python=3.7
 - scipy>1.4.1
-- sphinx-autobuild>=0.7
+- sphinx-copybutton
 - sphinx-notfound-page
-- sphinx-panels
 - sphinx>=1.5
 - typing-extensions
 - pip:

diff --git a/conda-envs/environment-dev-py38.yml b/conda-envs/environment-dev-py38.yml
@@ -23,9 +23,8 @@ dependencies:
 - python-graphviz
 - python=3.8
 - scipy>1.4.1
-- sphinx-autobuild>=0.7
+- sphinx-copybutton
 - sphinx-notfound-page
-- sphinx-panels
 - sphinx>=1.5
 - typing-extensions>=3.7.4
 - pip:

diff --git a/conda-envs/environment-dev-py39.yml b/conda-envs/environment-dev-py39.yml
@@ -23,9 +23,8 @@ dependencies:
 - python-graphviz
 - python=3.9
 - scipy>1.4.1
-- sphinx-autobuild>=0.7
+- sphinx-copybutton
 - sphinx-notfound-page
-- sphinx-panels
 - sphinx>=1.5
 - typing-extensions>=3.7.4
 - pip:

diff --git a/conda-envs/windows-environment-dev-py38.yml b/conda-envs/windows-environment-dev-py38.yml
@@ -27,8 +27,8 @@ dependencies:
 - pytest-cov>=2.5
 - pytest>=3.0
 - sphinx-autobuild>=0.7
+- sphinx-copybutton
 - sphinx-notfound-page
-- sphinx-panels
 - sphinx>=1.5
 - watermark
 - pip:

diff --git a/docs/logos/sponsors/numfocus.png b/docs/logos/sponsors/numfocus.png
diff --git a/docs/pymc-labs-logo.png → docs/logos/sponsors/pymc-labs.png b/docs/pymc-labs-logo.png → docs/logos/sponsors/pymc-labs.png
diff --git a/docs/pymc_logo.jpg b/docs/pymc_logo.jpg
diff --git a/docs/source/Advanced_usage_of_Aesara_in_PyMC.rst b/docs/source/Advanced_usage_of_Aesara_in_PyMC.rst
@@ -1,5 +1,5 @@
 :orphan:
-
+(Advanced_usage_of_Aesara_in_PyMC)=
 ..
     _referenced in docs/source/notebooks/table_of_contents_tutorials.js
 

diff --git a/docs/source/_templates/footer.html b/docs/source/_templates/footer.html
@@ -0,0 +1,9 @@
+<footer class="footer mt-5 mt-md-0">
+  <div class="container">
+    {% for footer_item in theme_footer_items %}
+    <div class="footer-item">
+      {% include footer_item %}
+    </div>
+    {% endfor %}
+  </div>
+</footer>
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -2,25 +2,25 @@
 
 <!-- Hide left sidebar in home page -->
 {% block docs_sidebar %}
-  {% if pagename != 'index' %}
-    {{ super() }}
-  {% endif %}
+{% if pagename != 'index' %}
+{{ super() }}
+{% endif %}
 {% endblock %}
 
 <!-- Hide right sidebar in home page -->
 {% block docs_toc %}
-  {% if pagename != 'index' %}
-    {{ super() }}
-  {% endif %}
+{% if pagename != 'index' %}
+{{ super() }}
+{% endif %}
 {% endblock %}
 
 <!-- Make body have full width in home page -->
 {% block docs_main %}
-  {% if pagename == 'index' %}
-    <main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
-      {% block body %} {% endblock %}
-    </main>
-  {% else %}
-    {{ super() }}
-  {% endif %}
+{% if pagename == 'index' %}
+<main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
+  {% block body %} {% endblock %}
+</main>
+{% else %}
+{{ super() }}
+{% endif %}
 {% endblock %}
diff --git a/docs/source/_templates/twitter.html b/docs/source/_templates/twitter.html
@@ -0,0 +1 @@
+<a class="twitter-timeline" data-width="300" data-height="500" data-dnt="true" href="https://twitter.com/pymc_devs?ref_src=twsrc%5Etfw">Tweets by pymc_devs</a> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
diff --git a/docs/source/about.rst b/docs/source/about.rst