Skip to content

Commit 09263b9

Browse files
committed
doc: change style of docs to alabaster
Change style of docs from bootstrap to alabaster. Clean up and simplify overall. Make the notebooks work correctly as part of the table of contents by including in a rst file rather than using index.ipynb as the main notebook index file. Also, stop using mock to allow solve_fe docs. The solve_fe function can now be imported without sfepy being required so remove all the mock paraphernalia from conf.py.
1 parent 86b6016 commit 09263b9

18 files changed

+115
-354
lines changed

Diff for: README.md

+2-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
1-
<p align="center">
2-
<img src="https://raw.githubusercontent.com/materialsinnovation/pymks/master/doc/pymks_logo.ico"
3-
height="60"
4-
alt="PyMKS logo"
5-
class="inline">
6-
</p>
7-
8-
<h1> <p align="center"><sup><strong>
9-
PyMKS &ndash; The Materials Knowledge System in Python
10-
</strong></sup></p>
11-
</h1>
1+
2+
# PyMKS Overview
123

134
<a href="https://travis-ci.org/materialsinnovation/pymks" target="_blank">
145
<img src="https://api.travis-ci.org/materialsinnovation/pymks.svg"

Diff for: doc/API.rst

+12
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44
API
55
===
66

7+
.. toctree::
8+
:maxdepth: 2
9+
10+
711
.. jinja::
812

13+
Table
14+
=====
15+
916
{% set functions = ['plot_microstructures', 'generate_delta', 'generate_multiphase', 'generate_checkerboard', 'solve_cahn_hilliard', 'solve_fe', 'coeff_to_real', 'paircorr_from_twopoint'] | sort %}
1017

1118
{% set classes = ['PrimitiveTransformer', 'LegendreTransformer', 'TwoPointCorrelation', 'FlattenTransformer', 'LocalizationRegressor', 'ReshapeTransformer'] | sort %}
@@ -20,11 +27,16 @@ API
2027
{{ class }}
2128
{% endfor %}
2229

30+
Functions
31+
=========
32+
2333
{% for function in functions %}
2434
.. autofunction:: pymks.{{ function }}
2535

2636
{% endfor %}
2737

38+
Classes
39+
=======
2840

2941
{% for class in classes %}
3042
.. autoclass:: pymks.{{ class }}

Diff for: doc/EXAMPLES.rst

+29-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,35 @@
33
Examples
44
========
55

6+
Overview
7+
--------
8+
9+
Start with the following notebooks if you are new to PyMKS.
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
14+
rst/notebooks/intro.ipynb
15+
rst/notebooks/checkerboard.ipynb
16+
17+
Homogenization
18+
--------------
19+
20+
.. toctree::
21+
:maxdepth: 2
22+
23+
rst/notebooks/stress.ipynb
24+
rst/notebooks/fiber.ipynb
25+
26+
Localization
27+
------------
28+
629
.. toctree::
730
:maxdepth: 2
831

9-
spatial_stats.rst
10-
homogenization.rst
11-
localization.rst
32+
rst/notebooks/elasticity.ipynb
33+
rst/notebooks/multiphase.ipynb
34+
rst/notebooks/elasticity3d.ipynb
35+
rst/notebooks/filter.ipynb
36+
rst/notebooks/cahn_hilliard.ipynb
37+
rst/notebooks/cahn_hilliard_legendre.ipynb
File renamed without changes.
File renamed without changes.

Diff for: doc/_templates/navbar.html

-6
This file was deleted.

Diff for: doc/_templates/release.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<p>
2+
<span class="navbar-version">
3+
<b>
4+
version: {{ release }}
5+
</b>
6+
</span>
7+
</p>

0 commit comments

Comments
 (0)