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

Host documentation #13

Closed
cako opened this issue Feb 27, 2023 · 3 comments
Closed

Host documentation #13

cako opened this issue Feb 27, 2023 · 3 comments

Comments

@cako
Copy link
Collaborator

cako commented Feb 27, 2023

Description

Currently, the documentation must be built locally by the developer. This is not the ideal solution; the documentation should be easily accessible via website.

What done means

A hosted webpage containing the documentation.

@mrava87
Copy link
Contributor

mrava87 commented Feb 27, 2023

Perfect, let me reply here then I merge:

For GitHub pages this is how I set it up for PyMarchneko: https://github.com/DIG-Kaust/pymarchenko/blob/main/Makefile (see the last two commands and this https://github.com/DIG-Kaust/pymarchenko/blob/main/docssrc/Makefile

The assumption here is that you cannot build the doc anywhere but locally (so not even with a GitHub action, which I think is the case for curvelops since we can’t really download the Curvelets code in CI). Also this isn’t really my own solution, I found it somewhere online but it has worked well for me :)

The other step is to go to Settings -> Pages of this repo and select Deploy from a branch and choose the gh-pages

@cako
Copy link
Collaborator Author

cako commented Mar 12, 2023

@cako cako closed this as completed Mar 12, 2023
@mrava87
Copy link
Contributor

mrava87 commented Mar 12, 2023

Yay! Nice, well done :)

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