example doc restructure

Author: OriolAbril

.gitmodules

@@ -1,8 +1,3 @@
-:orphan:
-
-..
-    _href from docs/source/index.rst
-
 .. _about:
 
 ***********

docs/source/about.rst

@@ -24,7 +24,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath(os.path.join("..", "..")))
-sys.path.insert(0, os.path.abspath("sphinxext"))
+# sys.path.insert(0, os.path.abspath("sphinxext"))
 import pymc3  # isort:skip
 
 # -- General configuration ------------------------------------------------
@@ -47,9 +47,11 @@
     "IPython.sphinxext.ipython_directive",
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.napoleon",
-    "gallery_generator",
+    # "gallery_generator",
     "myst_nb",
     "sphinx_panels",
+    "sphinx_design",
+    "sphinx_copybutton",
 ]
 
 # Don't auto-generate summary for class members.
@@ -146,6 +148,7 @@
     "arviz": ("https://arviz-devs.github.io/arviz/", None),
     "aesara": ("https://aesara.readthedocs.io/en/latest/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
+    "nb": ("https://pymc-examples.readthedocs.io/en/latest/", None),
 }
 
 
@@ -172,8 +175,14 @@
             "url": "https://twitter.com/pymc_devs",
             "icon": "fab fa-twitter-square",
         },
+        {
+            "name": "Discourse",
+            "url": "https://discourse.pymc.io",
+            "icon": "fab fa-discourse",
+        },
     ],
     "show_prev_next": False,
+    "navbar_align": "left",
     "navbar_start": ["navbar-logo", "navbar-version"],
     "navbar_end": ["search-field.html", "navbar-icon-links.html"],
     "search_bar_text": "Search...",

docs/source/learn.md renamed to docs/source/community.md

@@ -0,0 +1,17 @@
+# Contributing
+
+Explaining how to contribute to PyMC
+
+## Code related PRs
+
+## Documentation
+
+## Others
+Issue triaging? reviewing? proofreading...
+
+:::{toctree}
+:hidden:
+
+developer_guide
+developer_guide_implementing_distribution
+:::

docs/source/conf.py

@@ -0,0 +1,20 @@
+# PyMC3 documentation
+
+Page in construction
+
+:::{button-ref} learning
+
+Getting Started
+:::
+
+:::{toctree}
+:maxdepth: 1
+:hidden:
+
+installation
+learning
+api
+community
+contributing/index
+about
+:::

docs/source/developer_guide.rst renamed to docs/source/contributing/developer_guide.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 .. title:: PyMC3 Documentation
 
 .. raw:: html

docs/source/developer_guide_implementing_distribution.md renamed to docs/source/contributing/developer_guide_implementing_distribution.md

@@ -0,0 +1,27 @@
+# Installation guide
+
+Move the 3 wiki pages over to here.
+
+with sphinx_design we can have common content in a single place,
+and whenever there is some specific guidance that depends on OS use
+tabs, which can be syncronized. That is, if one tab is switched over to
+windows, all tabs will be moved to windows.
+
+::::{tab-set}
+:::{tab-item} Linux
+
+specific linux content
+:::
+
+:::{tab-item} MacOS
+
+specific macos content
+:::
+
+:::{tab-item} Windows
+
+specific windows content
+:::
+::::
+
+more common content

docs/source/contributing/index.md

@@ -0,0 +1,16 @@
+(learning)=
+# Learning
+
+## Step 1
+Links to books and pymc-devs/resources
+
+---
+## Step 2
+Links to beginner lever notebooks. For example,
+thanks to intersphinx, we can cite the getting started
+notebook with {doc}`nb:examples/getting_started`
+
+---
+## Step 3
+
+Links to intermediate notebooks