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.

Sign up for GitHub

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

Jump to bottom

Read the Docs Documentation #950

Draft
wants to merge 31 commits into
base: develop
Choose a base branch
from
Draft

Read the Docs Documentation #950

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
09e4c1b
Initial commit with rtd documentation skeleton
pshriwise Feb 19, 2024
2196135
Adding rtd artifacts to the ignore file
pshriwise Feb 19, 2024
8f6396f
Duplicating a lot of information in usersguide
pshriwise Feb 20, 2024
c82605f
Filling in user's guide, updating docs properties.
pshriwise Feb 23, 2024
b9b1450
Adding start to the file specification
pshriwise Feb 23, 2024
381199a
Cleaning up function signatures a bit.
pshriwise Feb 23, 2024
b7079b1
Adding tables on the MOAB file spec
pshriwise Feb 27, 2024
ba17858
Fixing header
pshriwise Feb 27, 2024
5abb5ab
Restructure
pshriwise Feb 27, 2024
c307f68
Structure updates to fill in the TOC
pshriwise Feb 28, 2024
9f3f49f
Adding intro blurb
pshriwise Feb 28, 2024
93d61eb
Adding image carousel
pshriwise Mar 1, 2024
f3a0098
Reworking landing page a bit.
pshriwise Mar 1, 2024
c4e4c80
Adjusting section headings
pshriwise Mar 1, 2024
f8d960a
Adding gallery
pshriwise Mar 1, 2024
7ac6921
Filing out empty sections, adding contribution guide.
pshriwise Mar 1, 2024
42116de
Update changelog
pshriwise Mar 1, 2024
7e29e65
Adding a section on the Coreform Cubit plugin in preparing solid models.
pshriwise Mar 4, 2024
8e7b4ca
Moving to an introduction to DAGMC section
pshriwise Mar 29, 2024
b488752
Adding some information on the Coreform Cubit workflow for metadata
pshriwise Mar 29, 2024
d5cf2a4
Reference Coreform tutorial for metadata for now
pshriwise Mar 29, 2024
eec1b77
Merge branch 'develop' into rtd
shimwell Apr 25, 2024
05ca90d
Apply suggestions from @gonuke
pshriwise Jun 7, 2024
0a0d2fe
Reverting changes to contribution guide
pshriwise Jun 7, 2024
c89f5ce
Removing gallery manual HTML scripts
pshriwise Jun 7, 2024
8f36251
Updates to include links to the Coreform version and adjust narrative…
pshriwise Jun 7, 2024
bf5cd17
Updating description of the MCNP importer in Coreform Cubit
pshriwise Jul 9, 2024
a500069
Removing redundant groups file
pshriwise Jul 9, 2024
e68dfbb
Correcting varialble name html_baseurl
pshriwise Jul 9, 2024
626378d
Updating notes on mcnp2cad and fixing links.
pshriwise Jul 9, 2024
f08e25a
Updating information on utilizing MCNP2CAD
pshriwise Sep 19, 2024
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
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ build

#ignore pyne amalgamation
src/pyne/pyne.cpp
src/pyne/pyne.h
src/pyne/pyne.h
docs/Doxyfile
docs/_build
1 change: 1 addition & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ if (BUILD_TESTS)
enable_testing()
endif ()

add_subdirectory(docs)
add_subdirectory(src)

dagmc_make_configure_files()
Expand Down
1 change: 1 addition & 0 deletions doc/CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Next version
* Simplify Housekeeping Process for DAGMC (#943)
* Allow Double Down v1.1.0 Installation in Dockerfile (#929)
* Inline documentation improvements (#945)
* RTD documentation site (#950)

v3.2.3
====================
Expand Down
4 changes: 2 additions & 2 deletions doc/contribute/index.rst
View file
Open in desktop
pshriwise marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Contribute
==========
Contributor's Guide
=================

DAGMC is an open-source BSD3-licensed project, open for anyone to fork, make
personal changes, or contribute changes back to us. DAGMC exists in the open so
Expand Down
2 changes: 2 additions & 0 deletions doc/usersguide/codes/index.rst
View file
Open in desktop
pshriwise marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still included in documentation? Is this file still relevant?

Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Monte Carlo code-specific steps
===============================

.. _code-specific-steps:

.. toctree::
:maxdepth: 1

Expand Down
18 changes: 18 additions & 0 deletions docs/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@


# Configure the documentation file

find_package(Doxygen)

set(DAGMC_SOURCE_DIR ${PROJECT_SOURCE_DIR})

if (DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Makefile ${CMAKE_CURRENT_BINARY_DIR}/Makefile COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/index.rst ${CMAKE_CURRENT_BINARY_DIR}/index.rst COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/conf.py ${CMAKE_CURRENT_BINARY_DIR}/conf.py COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/requirements.txt ${CMAKE_CURRENT_BINARY_DIR}/requirements.txt COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/make.bat ${CMAKE_CURRENT_BINARY_DIR}/make.bat COPYONLY)
else()
message(WARNING "Doxygen is required to build the documentation for double-down.")
pshriwise marked this conversation as resolved.
Show resolved Hide resolved
endif()
Loading
Loading