Refresh documentation #101

samcmill · 2018-12-10T19:37:51Z

This is a complete overhaul of the documentation.

Split the big monolithic files into smaller, more manageable chunks
Add tutorial
Add documentation for using HPCCM as a Python module
Build the building block and primitives documentation from source using pydocmd
Add additional links like the blog, SC18 paper, etc.

Copy building block documentation into the respective building block as pydoc

Tweak MILC recipe to further minimize the image size

Replace index.md with README.md

samcmill added 18 commits November 30, 2018 15:23

Refresh documentation

4d4f454

Copy building block documentation into the respective building block as pydoc

Copy primitive documentation into the respective primitive as pydoc

c28b3a5

Add Getting Started and Tutorial documentation pages

958fb72

Tweak MILC recipe to further minimize the image size

Proof tutorial content

0694a90

Replace index.md with README.md

Fix license link

76ddca0

Fix links

f2b51e2

Moved citation to its own file, added additional resources section

22ad3d8

Fix ADMIN magazine link

a2f9d0b

Add pydocmd autogenerated content

5e49506

Finished refreshing documention

b264ed9

Reformated primitives table and restored doc/README.md file

a8d71e4

fix typo

cebf8fa

fix typo

c88f5dc

spell check

1af6735

indent table of contents and fix up some links

26fe867

library -> module

0fa1337

misc documentation improvements

1844b68

Fix README title

8f57c15

samcmill merged commit 20b5ca1 into master Dec 10, 2018

samcmill deleted the refresh-documentation branch December 10, 2018 19:43

Provide feedback