Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a new style of generated documentation #508

Open
wants to merge 18 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
bbd5242
feat: add nested documentation option to SphinxWriter
joshessman-llnl Mar 23, 2021
d5e1685
feat: added container documentation to nested Sphinx format
joshessman-llnl Mar 23, 2021
05f390b
fix: ignore pindividual fields of primitive collections, don't hyperl…
joshessman-llnl Mar 23, 2021
94365ee
docs: add copyright to inlet docs and add writer page
joshessman-llnl Mar 23, 2021
2fb4c64
docs: reorganize docs to provide examples of both sphinx modes
joshessman-llnl Mar 23, 2021
e06d1fe
cleanup: add style and title selection options for the SphinxWriter
joshessman-llnl Mar 23, 2021
a38ec74
Merge branch 'develop' into feature/essman/nested_docs
joshessman-llnl Mar 29, 2021
14de6f2
Merge branch 'develop' into feature/essman/nested_docs
joshessman-llnl Mar 29, 2021
d23082d
Merge branch 'develop' into feature/essman/nested_docs
joshessman-llnl Mar 30, 2021
8bae440
Merge branch 'develop' into feature/essman/nested_docs
joshessman-llnl Apr 8, 2021
e2a60fa
fix: avoid duplicated hyperlinks by using container index
joshessman-llnl Apr 8, 2021
916c980
Merge branch 'develop' into feature/essman/nested_docs
joshessman-llnl Apr 19, 2021
eb57947
Merge branch 'develop' into feature/essman/nested_docs
joshessman-llnl Apr 27, 2021
9fc2515
cleanup: docs adjustments per @white238 suggestions
joshessman-llnl Apr 27, 2021
7a0015d
fix: copy-paste error with docs example
joshessman-llnl Apr 27, 2021
4eb53ee
rename: singular -> flat
joshessman-llnl May 3, 2021
844bb2b
cleanup: table -> nested in filenames
joshessman-llnl May 5, 2021
8834021
docs: disable sphinx numfig option, refactor mint docs accordingly
joshessman-llnl May 5, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
cleanup: table -> nested in filenames
  • Loading branch information
joshessman-llnl committed May 5, 2021
commit 844bb2b1676e764ed6f7b70dae434bcbe45be254
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. |check| unicode:: U+2611 .. CHECKED BOX

===============================================
Example Output: Input File Options (table mode)
Example Output: Input File Options (flat mode)
===============================================

--------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. |check| unicode:: U+2611 .. CHECKED BOX

====================================
MFEM Coefficient Output (table mode)
MFEM Coefficient Output (flat mode)
====================================

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. |check| unicode:: U+2611 .. CHECKED BOX

==================================
Nested Structs Output (table mode)
Nested Structs Output (flat mode)
==================================

------
Expand Down
8 changes: 4 additions & 4 deletions src/axom/inlet/docs/sphinx/writers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ compatible with the `Sphinx <https://www.sphinx-doc.org/en/master/>`_ documentat

The ``SphinxWriter`` currently has two styles available:

- A table-based style that, for each ``Container``, generates a table for its child fields and functions
- A flat style that, for each ``Container``, generates a table for its child fields and functions
- A nested style that includes a "table of contents" for each ``Container`` with links to full descriptions
of child fields and functions

Expand All @@ -32,23 +32,23 @@ For comparison, the following is produced from the ``documentation_generation.cp
.. toctree::
:maxdepth: 1

example1_table_documentation
example1_flat_documentation
example1_nested_documentation

...from the ``mfem_coefficient.cpp`` example:

.. toctree::
:maxdepth: 1

mfem_coefficient_table_documentation
mfem_coefficient_flat_documentation
mfem_coefficient_nested_documentation

...and from the ``nested_structs.cpp`` example:

.. toctree::
:maxdepth: 1

nested_structs_table_documentation
nested_structs_flat_documentation
nested_structs_nested_documentation

-----------
Expand Down