PDFmorph manual PDF and HTML #117
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #117 +/- ##
=======================================
Coverage 83.65% 83.66%
=======================================
Files 38 38
Lines 1891 1892 +1
=======================================
+ Hits 1582 1583 +1
Misses 309 309 ☔ View full report in Codecov by Sentry. |
|
I am happy to merge these fixes without pre-commit passing, but we need to figure out the right configuration of things to get this right. there seems to be a conflict between black and flake8. i left a comment on one of @Caden's prs. here ae some recommendations: i also thought it is better to go with 88 instead of 115 for the line length which will make abit more work, but good to standardize I think |
|
Opened PR #118 to fix |
Sparks29032
changed the title
doc/manual/acknowledgements.texinfo
Outdated
| Benjamin Frandsen during his PhD at Columbia Unversity, | ||
| and Long Yang from Tonji University. | ||
|
|
||
| The PDFmorph development team is the set of all contributors to the PDFgui project. |
There was a problem hiding this comment.
Yep, sorry referenced the PDFgui blurb
| For detailed instructions and full tutorial, consult the user manual | ||
| on our `website <www.diffpy.org/diffpy.pdfmorph/>`. |
There was a problem hiding this comment.
Reference user manual in README.rst.
| and some of what it can do. For a more detailed tutorial, check out | ||
| our :download:`user manual <../pdfmorph.pdf>`. |
There was a problem hiding this comment.
Reference user manual in quickstart.rst.
| To get started, please download our :download:`user manual <../pdfmorph.pdf>` | ||
| or visit the :ref:`quick_start`. |
There was a problem hiding this comment.
Reference user manual in index.rst.
| The DiffPy development team is the set of all contributors to DiffPy projects. | ||
| Each member of the development team maintains copyright on their individual | ||
| contributions to the code base. For a detailed contribution history of | ||
| @code{PDFmorph}, see the git logs at @url{https://github.com/diffpy/diffpy.pdfmorph}. | ||
|
|
||
| For more information about the application, please visit | ||
| @url{https://www.diffpy.org/diffpy.pdfmorph}. | ||
| Report any bugs to diffpy-users@@googlegroups.com or submit | ||
| an issue to @url{https://github.com/diffpy/diffpy.pdfmorph/issues}. |
There was a problem hiding this comment.
Edited per in-line comment.
When complete, this should close #24, close #26, and close #27. Can also close #30 and close #39 in this PR after the manual is finished.
@sbillinge I have commented changes to our current
.rstfiles (added references to the user manuals).You do not have to check the changes in the
.texinfofiles as I have compiled it into a PDF.If you have time, I would like some feedback on section 4 and what in that section is okay to include in the paper proper.
User manual todo:
Website todo (requires merging PR #120 and #121 and doing a pull):
README.rst