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.

Sign up for GitHub

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

Jump to bottom

Use readthedocs for documentation #493

Merged
merged 5 commits into from
Mar 1, 2024
Merged

Use readthedocs for documentation #493

merged 5 commits into from
Mar 1, 2024

Conversation

qiaojunfeng
Copy link
Collaborator

@qiaojunfeng qiaojunfeng commented Feb 28, 2024 •
edited
Loading

Close #484
Close #485

@qiaojunfeng
Use mike for docs versioning
5746108 
- Add version warning
- Auto deploy docs to `gh-pages` on github release

The commit is kept here as a reference.

We will switch to readthedocs to deploy multiple versions of the docs,
since mike use `gh-pages` branch to host the docs, increasing the size
of the repo in the long term. See wannier-developers#485 for more details.
@qiaojunfeng
Switch to readthedocs
ccb67c7
@qiaojunfeng qiaojunfeng mentioned this pull request Feb 28, 2024
Open
LecrisUT
LecrisUT reviewed Feb 29, 2024
View reviewed changes
.github/workflows/main.yml Outdated Show resolved Hide resolved
.readthedocs.yaml Outdated Show resolved Hide resolved
LecrisUT
LecrisUT approved these changes Mar 1, 2024
View reviewed changes
Copy link
Contributor

@LecrisUT LecrisUT left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Another tip, in actions/setup-python, python-version: 3.x is equivalent with the latest released version.

(the project does not appear on readthedocs.org, but I guess the backend was not setup yet)

@qiaojunfeng
Copy link
Collaborator Author

Another tip, in actions/setup-python, python-version: 3.x is equivalent with the latest released version.

Thanks, fixed as well.

(the project does not appear on readthedocs.org, but I guess the backend was not setup yet)

I don't have enough permission to import the repo on RTD, already asked Giovanni to do this.

LecrisUT
LecrisUT reviewed Mar 1, 2024
View reviewed changes
.github/workflows/main.yml Outdated Show resolved Hide resolved
@qiaojunfeng @LecrisUT
Fix for mkdocs-bibtex with python 3.12
99cc773 
Python 3.12 does not install `setuptools` in virtual env, therefore
`pkg_resources` is missing but `mkdocs-bibtex` explicitly imports it.
The solution is to explicitly install `setuptools` in the virtual env.

See https://docs.python.org/3/whatsnew/3.12.html

Co-authored-by: Cristian Le <github@lecris.me>
@giovannipizzi giovannipizzi merged commit 7806b3f into wannier-developers:develop Mar 1, 2024
4 checks passed
@qiaojunfeng qiaojunfeng mentioned this pull request Mar 1, 2024
Closed
@qiaojunfeng qiaojunfeng linked an issue Mar 1, 2024 that may be closed by this pull request
Support for multiple version of the documentation #475
Closed
@qiaojunfeng qiaojunfeng deleted the rtd branch March 1, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LecrisUT LecrisUT LecrisUT approved these changes

@giovannipizzi giovannipizzi giovannipizzi approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support for multiple version of the documentation
3 participants
@qiaojunfeng @giovannipizzi @LecrisUT