Skip to content

Commit 667d83b

Browse files
OriolAbrilmartinacantaro
authored andcommitted
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
1 parent f184912 commit 667d83b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+446
-1444
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ tags
1717

1818
# Sphinx
1919
_build
20+
docs/jupyter_execute
2021

2122
# Merge tool
2223
*.orig

.gitmodules

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/logos/sponsors/numfocus.png

41.4 KB
Loading
File renamed without changes.

docs/pymc_logo.jpg

-82.9 KB
Binary file not shown.

docs/source/_templates/footer.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<footer class="footer mt-5 mt-md-0">
2+
<div class="container">
3+
{% for footer_item in theme_footer_items %}
4+
<div class="footer-item">
5+
{% include footer_item %}
6+
</div>
7+
{% endfor %}
8+
</div>
9+
</footer>

docs/source/_templates/layout.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
<!-- Hide left sidebar in home page -->
44
{% block docs_sidebar %}
5-
{% if pagename != 'index' %}
6-
{{ super() }}
7-
{% endif %}
5+
{% if pagename != 'index' %}
6+
{{ super() }}
7+
{% endif %}
88
{% endblock %}
99

1010
<!-- Hide right sidebar in home page -->
1111
{% block docs_toc %}
12-
{% if pagename != 'index' %}
13-
{{ super() }}
14-
{% endif %}
12+
{% if pagename != 'index' %}
13+
{{ super() }}
14+
{% endif %}
1515
{% endblock %}
1616

1717
<!-- Make body have full width in home page -->
1818
{% block docs_main %}
19-
{% if pagename == 'index' %}
20-
<main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
21-
{% block body %} {% endblock %}
22-
</main>
23-
{% else %}
24-
{{ super() }}
25-
{% endif %}
19+
{% if pagename == 'index' %}
20+
<main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
21+
{% block body %} {% endblock %}
22+
</main>
23+
{% else %}
24+
{{ super() }}
25+
{% endif %}
2626
{% endblock %}

docs/source/about.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
:orphan:
2-
3-
..
4-
_href from docs/source/index.rst
5-
61
.. _about:
72

83
**********

docs/source/api.rst

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
:orphan:
2-
3-
..
4-
_"api" is referenced in html_theme_options docs/source/conf.py
5-
61
.. _api:
72

83
*************
@@ -13,20 +8,14 @@ API Reference
138
:maxdepth: 2
149

1510
api/distributions
16-
api/bounds
17-
api/inference
18-
api/glm
1911
api/gp
20-
api/plots
21-
api/stats
22-
api/backends
23-
api/math
24-
api/data
2512
api/model
26-
api/model_graph
27-
api/variables
28-
api/shape_utils
2913
api/ode
14+
api/samplers
15+
api/smc
16+
api/step_methods
17+
api/inference
18+
api/plots
3019

3120
Indices and tables
3221
===================

docs/source/api/backends.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)