Skip to content

Commit

Permalink
Merge pull request #10 from LLNL/feature/capps2/single-doxygen
Browse files Browse the repository at this point in the history
Unified Sphinx into one.
  • Loading branch information
agcapps committed Apr 30, 2019
2 parents 13c5898 + 37586dc commit 5808439
Show file tree
Hide file tree
Showing 62 changed files with 80 additions and 2,735 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: src/docs/sphinx/web_main/conf.py
configuration: src/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
formats: all
Expand Down
3 changes: 3 additions & 0 deletions src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ add_subdirectory(tools)
add_subdirectory(examples)

if (AXOM_ENABLE_DOCS)
if (SPHINX_FOUND)
blt_add_sphinx_target( axom_docs )
endif()
add_subdirectory(docs)
endif()

Expand Down
7 changes: 0 additions & 7 deletions src/axom/core/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,6 @@ if (AXOM_ENABLE_TESTS)
add_subdirectory(tests)
endif()

################################
# Add docs
################################
if (AXOM_ENABLE_DOCS)
add_subdirectory(docs)
endif()

################################
# Add code checks
################################
Expand Down
14 changes: 0 additions & 14 deletions src/axom/core/docs/CMakeLists.txt

This file was deleted.

7 changes: 0 additions & 7 deletions src/axom/lumberjack/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,6 @@ if (AXOM_ENABLE_TESTS)
add_subdirectory(tests)
endif()

################################
# Add docs
################################
if (AXOM_ENABLE_DOCS)
add_subdirectory(docs)
endif()

################################
# Add code checks
################################
Expand Down
2 changes: 1 addition & 1 deletion src/axom/lumberjack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Lumberjack: Log filtering and aggregation {#lumberjacktop}

[Lumberjack](@ref axom::lumberjack) provides functionality to filter log events based on priority, rate, and volume. It coordinates with but does not require the [SLIC](@ref slictop) component.

The [introduction to Lumberjack](../../../sphinx/lumberjack_docs/html/index.html)
The [introduction to Lumberjack](../../../sphinx/axom_docs/html/axom/lumberjack/docs/sphinx/index.html)
covers these concepts in more detail.
12 changes: 0 additions & 12 deletions src/axom/lumberjack/docs/CMakeLists.txt

This file was deleted.

10 changes: 0 additions & 10 deletions src/axom/lumberjack/docs/sphinx/CMakeLists.txt

This file was deleted.

277 changes: 0 additions & 277 deletions src/axom/lumberjack/docs/sphinx/conf.py

This file was deleted.

10 changes: 5 additions & 5 deletions src/axom/mainpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ indicate hard dependencies; dashed links indicate optional dependencies.

# Further documentation

- [User manual](../../../sphinx/web_main_docs/html/index.html)
- [Quick start guide](../../../sphinx/quickstart_guide_docs/html/index.html)
- [Development guide](../../../sphinx/dev_guide_docs/html/index.html) (intended for Axom contributors)
- Coding [style guide](../../../sphinx/coding_guide_docs/html/index.html) (intended for Axom contributors)
- Please see our [license](../../../LICENSE) and accompanying [notice](../../../NOTICE).
- [User manual](../../../sphinx/axom_docs/html/docs/index.html)
- [Quick start guide](../../../sphinx/axom_docs/html/docs/sphinx/quickstart_guide/index.html)
- [Development guide](../../../sphinx/axom_docs/html/docs/sphinx/dev_guide/index.html) (intended for Axom contributors)
- Coding [style guide](../../../sphinx/axom_docs/html/docs/sphinx/coding_guide/index.html) (intended for Axom contributors)
- Please see our [license](../../../sphinx/axom_docs/html/docs/licenses.html).

Each component contains a `test` subdirectory containing numerous code unit tests and an `example` subdirectory with more extensive demonstrations of the Axom library. The Sidre, Mint, and Slam examples include several versions of the `lulesh` mini-app, an implementation of the heat equation and a 1-D shock tube simulation.

0 comments on commit 5808439

Please sign in to comment.