Read the Docs Documentation #950
Conversation
There was a problem hiding this comment.
Thanks @pshriwise - this looks mostly good. A few comments, probably only one or two really substantive ones - and we can decide to tackle these in subsequent PRs, perhaps, in order to move this forward.
| 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.") |
There was a problem hiding this comment.
| message(WARNING "Doxygen is required to build the documentation for double-down.") | |
| message(WARNING "Doxygen is required to build the documentation for DAGMC.") |
There was a problem hiding this comment.
😬 clear lift there I suppose. Thanks!
docs/index.rst
Outdated
| .. Double-Down documentation master file, created by | ||
| sphinx-quickstart on Fri Mar 26 13:29:08 2021. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. |
There was a problem hiding this comment.
Update from Double Down copy/paste
There was a problem hiding this comment.
Done. Good catch. Thanks!
docs/index.rst
Outdated
| DAGMC is a toolkit for performing Monte Carlo radiation transport simulations on | ||
| CAD-based geometry models. It is built on top of the MOAB mesh database. DAGMC | ||
| is developed and maintained by the Computationan Nuclear Engineering Research | ||
| Group (CNERG) at the University of Wisconsin -- Madison. |
There was a problem hiding this comment.
This seems light on front page content, even compared the relatively light current page? Is that intentional or expedient?
There was a problem hiding this comment.
I've renamed/repurposed the "Is DAGMC for you?" section to an Introduction to DAGMC and made it more prominent on the main page. Does that read better?
doc/contribute/index.rst
Outdated
There was a problem hiding this comment.
will this file become irrelevant?
doc/usersguide/codes/index.rst
Outdated
There was a problem hiding this comment.
will this file become irrelevant?
| * visited_surface (bool) | ||
| * turned on when a surface interaction is handled either in surface crossing or reflection | ||
| * turned off immediately following the next ray fire | ||
| * last_uvw (unit direction vector) |
There was a problem hiding this comment.
| * last_uvw (unit direction vector) | |
| * `last_uvw` (unit direction vector) |
| * set following every ray fire to record direction of last ray_fire | ||
| * note: not reset for each history because is not used until after | ||
| the first ray_fire in each history | ||
| * last_nps (int) |
There was a problem hiding this comment.
| * last_nps (int) | |
| * `last_nps` (int) |
|
|
||
| .. _coreform_export: | ||
|
|
||
| Using the Coreform Cubit plugin |
There was a problem hiding this comment.
Should this be in the cubit_basics?
docs/usersguide/groups.txt
Outdated
There was a problem hiding this comment.
should this be an RST file? I can't remember why its a TXT file?
docs/usersguide/mcnp2cad.rst
Outdated
There was a problem hiding this comment.
rewrite this to reference the Cubit importer? standalone code is not really available anymore
|
resolved a simple conflict in the change log for the PR |
Description
This PR includes a documentation site overhaul using a read the docs theme. I've translated most of the exisiting content as a pure addition to the repository (for now) to support a content review before proceeding to cleanup the files and git history.
Highlights of this are:
A rendered version of this draft content can be found here.
Motivation and Context
RTD is a well-known theme in the open-source community. The aim here is to provide familiarity as part of the new user experience with DAGMC