Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc req updates #293

Merged
merged 10 commits into from
Jul 3, 2022
Merged

Doc req updates #293

merged 10 commits into from
Jul 3, 2022

Conversation

alegresor
Copy link
Collaborator

  • consolidate dependencies to a single environment.yml file compatible across all platforms with Python 3.9
  • update GitHub Actions and ReadTheDocs to compile based on new environment.yml file
  • note that we remove LatNet Builder from the developer environment in order to use Python 3.9. When LatNet Builder updates to support Python >= 3.9 we will add it back

@alegresor alegresor requested a review from schoi32 July 1, 2022 19:07
@sou-cheng-choi
Copy link
Collaborator

sou-cheng-choi commented Jul 2, 2022

Dear Aleksei, I have tested on Mac M1. After setting up a new virtual environment with the much cleaner environment.yml, all tests passed. For the make targets such as "doc_html", I got the following error message:

# Make Directries
# READMEs --> RST
make: pandoc: No such file or directory
make: *** [_doc] Error 1

So I proceeded to install pandoc by "conda install -c conda-forge pandoc"; the installed version is 2.2. Afterward, all documentation generation tasks became successful.

Also need to update "makefile" to remove mentions of folder "requirements" and "dev*.txt" since they no longer exist.

I have made a commit with the above changes and now make tests and make doc_* succeed on my machine:

https://github.com/QMCSoftware/QMCSoftware/commit/7d8238fa1df143a252d8a2d454beb7909b9a58fc

@codecov
Copy link

codecov bot commented Jul 3, 2022

Codecov Report

Merging #293 (7d8238f) into develop (8765a32) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #293   +/-   ##
========================================
  Coverage    88.06%   88.06%           
========================================
  Files           87       87           
  Lines         4206     4206           
========================================
  Hits          3704     3704           
  Misses         502      502           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8765a32...7d8238f. Read the comment docs.

@alegresor alegresor merged commit 7b35641 into develop Jul 3, 2022
jagadeesr pushed a commit that referenced this pull request Dec 14, 2022
@alegresor alegresor deleted the doc_req_updates branch March 27, 2023 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants