Consolidate Arkane documentation input file #1544
Conversation
goldmanm
force-pushed
the
arkane_documentation_consolidation
branch
from
fbd5676 to
4df6f6c
Compare
Codecov Report
@@ Coverage Diff @@
## master #1544 +/- ##
==========================================
+ Coverage 41.84% 41.86% +0.01%
==========================================
Files 165 165
Lines 28008 28008
Branches 5713 5713
==========================================
+ Hits 11721 11726 +5
+ Misses 15498 15494 -4
+ Partials 789 788 -1
Continue to review full report at Codecov.
|
| activeJRotor = True, | ||
| sensitivity_conditions = [[(1000, 'K'), (1, 'bar')], [(1500, 'K'), (10, 'bar')]] | ||
| ) | ||
| Cantherm also has the ability to vary barrier heights and generate sensitivity coefficients as a function of changes |
There was a problem hiding this comment.
Sorry, I didn't see the name change in just the email (so I just squashed the two commits together and thought it was done). Just replaced the two references to Cantherm with Arkane.
goldmanm
force-pushed
the
arkane_documentation_consolidation
branch
2 times, most recently
from
4129662 to
1a670d4
Compare
|
I got an error compiling html: |
|
@goldmanm, can you take a look at my comment above? |
There was originally a lot of duplication between the input.rst and input_pdep.rst. This creates issues with maintenance and accuracy. This commit reduces documentation duplication by integrated the information about pdep into the original input file and removed the input_pdep.rst file. This should provide more accurate information and improve maintainability. Elaborated on Arkane's pdep sensivitity and moved the syntax example next to the description of parameters. Added column to the parameter list specifying whether parameter is required or not.
goldmanm
force-pushed
the
arkane_documentation_consolidation
branch
from
1a670d4 to
bbd8e83
Compare
|
Just updated. It should be fixed. Though when i compile the documentation, I get 132 warnings, due to issues with Sphinx's autodoc function failing. I am able to open the html and look at all the tables without error now. |
There was originally a lot of duplication between the input.rst
and input_pdep.rst. This creates issues with maintenance and
accuracy. This commit reduces documentation duplication by integrated
the information about pdep into the original input file and removed
the input_pdep.rst file. This should provide more accurate information
and improve maintainability.
Reviewer Tips
Read through changes, build and ensure no errors.