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

We should publish documentation for older release versions in addition to latest #2504

Open
cdcapano opened this issue Feb 13, 2019 · 0 comments
Assignees

Comments

@cdcapano
Copy link
Contributor

Right now you can only access documentation online for the current master version of pycbc. This can cause issues if changes occurred to master since the latest release. For example, as described in Issue #2502, the version of pycbc_inference on master gets the low frequency cutoff to use for the likelihood from the configuration file. The example configuration files (which can be downloaded from the documentation page) reflect this. However, in the current release version, the low frequency cutoff is set on the command line. This means that if a user installs pycbc using pip, then tries to run pycbc inference using the examples documented online, they'll get an error.

If docs pages existed for each version, then the user would know (or at least could figure out) that they should look at the version of the docs corresponding to the version of pycbc that they have. This would be similar to how numpy/scipy work.

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

4 participants