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

"latest" documentation looks outdated #358

Open
skirpichev opened this issue Jan 25, 2023 · 8 comments
Open

"latest" documentation looks outdated #358

skirpichev opened this issue Jan 25, 2023 · 8 comments

Comments

@skirpichev
Copy link
Contributor

E.g. recent 8e378bd seems to be missing. Looking on the project page, there are builds only month ago.
Are there reasons to not automate documentation building (by merging a pr)? (After 8737db0 - successful sphinx-build is a prerequisite for passing CI on the Github Actions.)

@casevh
Copy link
Collaborator

casevh commented Jan 26, 2023

Automating the documentation build process would be awesome!

@skirpichev
Copy link
Contributor Author

skirpichev commented Jan 26, 2023

@casevh, to enable docs building on a merge event you can do something like this:
https://docs.readthedocs.io/en/stable/integrations.html#github
Note, that it's possible to build also html docs for pr's:
https://docs.readthedocs.io/en/stable/pull-requests.html
(You can see how it looks here: diofant/diofant#1287 Note the docs/readthedocs.org:diofant checker in the list of checks.)

@casevh
Copy link
Collaborator

casevh commented Jan 26, 2023

Thanks. I'll look at that tomorrow.

@skirpichev
Copy link
Contributor Author

Related issue: #329

@skirpichev
Copy link
Contributor Author

Ok, after #399, more or less up to date docs are on https://gmpy.readthedocs.io/ (@casevh, let me know if it would be better to rename the rtfd project from "gmpy".)

@casevh
Copy link
Collaborator

casevh commented Apr 6, 2023

That would be great. I triggered a manual build on https://gmpy2.readthedocs.io/ and it was successful.

@skirpichev
Copy link
Contributor Author

That would be great.

@casevh, I guess you are about renaming of https://gmpy.readthedocs.io/. Now it's https://gmpy-skirpichev.readthedocs.io/

Probably, we can close this issue?

@skirpichev
Copy link
Contributor Author

Now latest documentation is outdated again, e.g. prev_prime() function is missing (c.f. https://gmpy-skirpichev.readthedocs.io/).

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

No branches or pull requests

2 participants