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

Bootstrap docs from template #21

Merged
merged 64 commits into from
Oct 18, 2024
Merged

Bootstrap docs from template #21

merged 64 commits into from
Oct 18, 2024

Conversation

grst
Copy link
Collaborator

@grst grst commented Sep 21, 2024

I added a basic sphinx setup from the cookiecutter template.

Still need to decide whether to host this on readthedocs or github-pages.

For now, it's possible to build manually, like this:

pip install -e ".[dev,test,doc]"
cd docs
make html

Some info on how to write docs in this sphinx setup are here:
https://cookiecutter-scverse-instance.readthedocs.io/en/latest/contributing.html#writing-documentation

Just in case you are bored, @DSchreyer ;)

Copy link
Contributor

github-actions bot commented Oct 18, 2024

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-10-18 08:20 UTC

@grst grst marked this pull request as ready for review October 18, 2024 08:12
@grst grst merged commit fa898a3 into main Oct 18, 2024
5 checks passed
@grst grst deleted the sphinx-docs branch October 18, 2024 08:20
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

Successfully merging this pull request may close these issues.

2 participants