docs: Migrate over a lightweight version of documentation #23
Conversation
| .wy-table-responsive table th { | ||
| white-space: normal !important; | ||
| word-break: normal !important; | ||
| } |
There was a problem hiding this comment.
We might want to add this file or something like this to the main scikit-package. Otherwise, when you render tables in the sphinx RTD theme the tables dont fully load on the page. you have to scroll over to view the whole thing. This code wraps the text in the table so it renders nicely.
There was a problem hiding this comment.
fyi I dont know how to code in C very well so i got help from chatGPT here
There was a problem hiding this comment.
@bobleesj do you agree? It makes sense to me.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #23 +/- ##
=======================================
Coverage 75.67% 75.67%
=======================================
Files 3 3
Lines 37 37
=======================================
Hits 28 28
Misses 9 9 🚀 New features to boost your workflow:
|
| conda create -n <package_name>-env python=3.13 \ | ||
| --file requirements/tests.txt \ | ||
| --file requirements/conda.txt | ||
|
|
There was a problem hiding this comment.
do we want installation instructions in the docs?
There was a problem hiding this comment.
yes please. We are not sure what they are going to be yet though. Probably conda-forge only.
There was a problem hiding this comment.
image is from current cmi docs
| .. image:: ./img/diffpycmi_screenshot.png | ||
| :alt: codecov-in-pr-comment | ||
| :width: 400px | ||
| :align: center |
There was a problem hiding this comment.
This text is also from current cmi docs
| - `doc <https://www.diffpy.org/pyobjcryst/>`_ | ||
| * - `libdiffpy <https://github.com/diffpy/libdiffpy>`_ | ||
| - C++ library for calculation of PDF and other real-space quantities. | ||
| - `doc <https://www.diffpy.org/libdiffpy/>`_ |
There was a problem hiding this comment.
Both new tables are also from current cmi docs but with updated/not broken links except cxxtest, their doc link is broken so i just put the broken link there for now.
|
this is fantastic! Not sure why it didn't show up on my notificationss. Sorry about that. |
|
@sbillinge thanks! No worries |
|
Plenty more work (examples/tutorials/reference to PDF Primer and so on. After we port over the existing documentation, we would like to make the docs more valuable and useful. Actually, adoption of diffpy.cmi is severly limited by the limited docs. This doesn't have to be done before the upcoming release, but it would be good to do it before a big public rollout. |
|
Here are some diffpy.srfit docs: https://www.diffpy.org/diffpy.srfit/ |
Beginning of migration of diffpy.cmi documentation. Most info here is from the current documentation: https://www.diffpy.org/products/diffpycmi/index.html. For now, I've included a link to a repo with example problems using diffpy.cmi in the tutorials section. Was thinking we can configure/build new tutorials in a later release. See ss for updated changes to the current docs.