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

Deploy docs on release only #305

Open
manulera opened this issue Oct 9, 2024 · 1 comment
Open

Deploy docs on release only #305

manulera opened this issue Oct 9, 2024 · 1 comment

Comments

@manulera
Copy link
Collaborator

manulera commented Oct 9, 2024

For now, docs get deployed everytime someone pushes to the repository directly. This means that the documentation is not in sync with what the pypi repository contains.

We should deploy to the docs site only when we make a new release, but it would also be good to keep another page with the "development" version docs (pending on what we decide with #302)

Multi-version is supported by sphinx, but I have not checked how to implement that yet.

This is related to #304
manulera added a commit that referenced this issue Oct 10, 2024
@manulera
update README + closes #305
5834739
@manulera
Copy link
Collaborator Author

For now, I have made it so that the docs are only deployed when pushing / PRing to master. We can see how to do the rest in the future.

manulera added a commit that referenced this issue Oct 11, 2024
@manulera
New docs (#304)
768c6fa 
* new docs

* update action

* update action

* fix typo in action

* update README + closes #305

* improve docs

* document how docs work

* fix autogen_docs.sh

* fix crispr docstring
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@manulera