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

Update docs #94

Open
mmagnuski opened this issue Aug 6, 2021 · 4 comments
Open

Update docs #94

mmagnuski opened this issue Aug 6, 2021 · 4 comments

Comments

@mmagnuski
Copy link
Owner

The docs have been last built long time ago. It's time to update them. And it would be best to add doc-building to the CIs.
Also: remove mac OS builds cause they are no longer free for OSS on Travis.

@sappelhoff
Copy link
Contributor

I suggest to move the tests to GitHub actions, were you can easily get testing for windows, mac, and linux for free -- for an easy setup, see e.g., https://github.com/sappelhoff/pyprep/blob/master/.github/workflows/python_tests.yml

Let me know if you want me to lend a hand with that.

@sappelhoff
Copy link
Contributor

re: docs -- I see that you host them on a different repo: https://github.com/mmagnuski/borsar.github.io

(and that they haven't been updated since 2018? 😆)

This setup is very similar to the one we use for https://github.com/autoreject/autoreject ... if you want to keep this setup, I suggest to use a circleci workflow to automatically push the docs to that repo on each commit to master. --> That'd give you up to date "dev docs" at least.

Once you make the first release of borsar, it'd be advisable to also distinguish between dev docs and stable docs. I can also help with this if you want to (but it'd probably be better if you do it, because there is a lot of stuff that needs admin access)

For the particular autoreject workflow as an example, see: https://github.com/autoreject/autoreject/blob/f1f3536b2f73bee16db3134a312c7fcd2ae25a59/.circleci/config.yml#L56-L89

@mmagnuski
Copy link
Owner Author

Great, thanks! I'll do as you suggest. You can ignore my comment about travis ci in PR, I didn't read this when I wrote that comment.

@sappelhoff
Copy link
Contributor

I just figured -- in case you want to use conda in GitHub actions, here are two more examples:

notice the shell: bash -l {0} at each run step

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