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

Can API Documentation for stable versions be made available? #10

Open
frou opened this issue Nov 30, 2021 · 1 comment
Open

Can API Documentation for stable versions be made available? #10

frou opened this issue Nov 30, 2021 · 1 comment

Comments

@frou
Copy link

frou commented Nov 30, 2021

Hi there - Regarding the API Documentation site: https://www.psycopg.org/psycopg3/docs/api/index.html - it seems to basically show the docs for the HEAD of the psycopg/psycopg repo master branch? i.e. psycopg 3.1dev0 at the moment.

But from a user perspective, we always want to look at the docs for the version of the library that we are actually using, i.e. 3.0 or 3.0.5 at the moment.

So either having a version selection widget on the site, or only building the site for the most recent stable version, seems like it would be better.

@dvarrazzo
Copy link
Member

The documentation for 3.0 or 3.0.5 is the same, because the release is only a bugfix. New features are clearly indicated (by an "added/changed in version x.y").

However, yes, I have thought for a while to generate at least minor release documentation. I can try and do something approaching to a stable release of 3.1.

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