Haoti/doc update #717
Open
Haoti/doc update #717
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix wrong brnahc
add working directly
Build api docuemtations.
…into haoti/doc_update
* Update link for user guide and api documentation. * Update the paper.
Change the workflow building the documentation only when push the commit on the master branch.
…into haoti/doc_update
Change the workflow branch to master so that only when push to master the documentation will be updated.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #717 +/- ##
==========================================
- Coverage 32.74% 32.10% -0.65%
==========================================
Files 215 215
Lines 35065 36218 +1153
Branches 14071 14540 +469
==========================================
+ Hits 11482 11627 +145
- Misses 21708 22668 +960
- Partials 1875 1923 +48 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
IvanaGyro
requested changes
Nov 29, 2025
Collaborator
IvanaGyro
left a comment
IvanaGyro
left a comment
There was a problem hiding this comment.
The commit history includes some commit for testing. Can you squash those commits which do not take effect to the final change into the related commits?
| * Boost v1.53+ [check_deleted, atomicadd, intrusive_ptr] | ||
| * openblas (or mkl, see below) | ||
| * gcc v6+ (or icpc, see below) (recommand latest or equivalent clang on Mac/Linux with C++11 support) (required -std=c++11) | ||
| * gcc v13+ (or icpc, see below) (recommand latest or equivalent clang on Mac/Linux with C++20 support) (required -std=c++20) |
Collaborator
There was a problem hiding this comment.
The dependency list is not completed here. Refer to the conda build receipt for the full list.
| * pybind11 >= 3.0.0 | ||
| * python-graphviz | ||
| * graphviz | ||
| * numpy |
Collaborator
There was a problem hiding this comment.
Runtime dependencies and build time dependencies are mixed here.
| $conda config --add channels conda-forge | ||
| $conda create --name cytnx python=3.8 llvm-openmp | ||
| $conda create --name cytnx python=3.9 llvm-openmp |
Collaborator
There was a problem hiding this comment.
I think llvm-openmp is not needed.
| .. code-block:: shell | ||
| $conda install cmake make boost libboost git compilers numpy openblas arpack pybind11 beartype | ||
| $conda install cmake make boost libboost git compilers numpy openblas arpack pybind11 beartype arpack |
Collaborator
There was a problem hiding this comment.
arpack is repeated. libboost is not needed.
| | options | default | description | | ||
| +------------------------+-------------------+------------------------------------+ | ||
| | -DCMAME_INSTALL_PREFIX | /usr/local/cytnx | Install destination of the library | | ||
| | -DCMAKE_INSTALL_PREFIX | /usr/local/cytnx | Install destination of the library | |
Collaborator
There was a problem hiding this comment.
Some option below are removed. For example USE_ICPC and USE_OMP.
| Generate API documentation | ||
| ************************************* | ||
| An API documentation can be generated from the source code of Cytnx by using doxygen. The documentation is accessible online at <https://kaihsinwu.gitlab.io/cytnx_api/>. To create it locally, make sure that doxygen is installed: | ||
| An API documentation can be generated from the source code of Cytnx by using doxygen. The documentation is accessible online at `here <../api_build/html/index.html>`__. To create it locally, make sure that doxygen is installed: |
Collaborator
There was a problem hiding this comment.
How about online <../api_build/html/index.html>.?
|
|
||
| 1. We do not support a native Windows package at this stage. If you are using Windows OS, please use WSL. | ||
| 2. [0.9] Currently, the supported Python versions are updated to: linux -- 3.8/3.9/3.10; MacOS-osx64 -- 3.7+ (no conda support). You can change the python=* argument to the version you like. | ||
| 2. Currently, the supported Python versions are updated to: linux -- 3.9+; MacOS-osx64 -- 3.9+ (no conda support). You can change the python=* argument to the version you like. |
Collaborator
There was a problem hiding this comment.
We have already supported macOS on conda.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR resolves issue #587 and migrates the documentation build action into this repository. However, we will still keep the separate Cytnx_doc repository because its GitHub Pages are used to host the online documentation:
https://cytnx-dev.github.io/Cytnx_doc/.
The workflow now deploys all generated documentation files from this repo to the
gh-pagesbranch of Cytnx_doc, ensuring that the online documentation is kept up to date:Cytnx/.github/workflows/docs.yml
Line 45 in b19f176
We may also consider hosting the documentation directly from this repository in the future (I currently do not have access to enable GitHub Pages here).
This PR also updates the API documentation. The “latest version” refers to documentation generated from the
masterbranch. And the online documentation will be updated when a commit push to themasterbranch.Additionally, all broken links have been fixed, and the main
READMEpage has been updated.