-
Notifications
You must be signed in to change notification settings - Fork 9
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
Docs #234
Docs #234
Conversation
I'm not surprised at all that some things were missing, broken or not used. Once sphinx is working and auto-updating via travis, I'll integrate (or drop) the rst files that are not currently used.
Ah. I'd never heard of https://github.com/drdoctr/doctr. Thanks.
I got an email notification saying you've added the ssh encrypted key, so I assume that's working now. And yes, you should still have rights, since I haven't removed you and don't plan to 😉. But I'd also like to learn more about what's involved.
Thanks! |
👍
I plan to keep it that way, unless you go to the dark side ... |
This PR addresses #233 |
Yep. I got that part working. If everything works we should have a GH page with the docs once this is merged. (There may be a few hiccups but I'll only be able to see them when |
BTW, I fixed a few test failures too. Nothing major, just updates. |
Yup, I saw that. |
You removed https://github.com/ODM2/WOFpy/blob/master/conda.recipe/meta.yaml. I trust you on that one, since I don't know better. But since that's the only file in the |
The directory is also removed (git does not allow for empty directories). The tests are now all on the |
- conda activate TEST | ||
- python -m pip install . --no-deps -vv | ||
- python wof/examples/flask/cbi/build_cbi_cache.py || exit 1 | ||
- pytest -s -rxs -v -k "not test_odm2_dao_sqlite" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@emiliom we exchanged 1-line here and all the lines in the conda.recipe
for these 5 lines, shorter and easier to follow b/c now the tests are all in a single file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's good to go.
It's been 12 minutes since the merge, and http://odm2.github.io/WOFpy/ isn't available yet. How long does it take for that first build? Or is there more you need to do first? I'm not in a rush. Just want to know what to expect. |
It should not take more than a few minutes, but I forgot to create the doc env. That is fixed in #235 |
Some problems I found when building the docs:
graphics/companylogos.png
;ODM1Services.rst
,ODM2Services.rst
andchanges.rst
;linkcheck
failures (runmake linkcheck
to see the URLs that are failing but many are "dummy" URLs and should be marked as expected failures).Note that I added an automatic build and upload withdoctr
but that won't work until we create an ssh encrypted key for the project. (Not sure if I still have the rights to create those here, if not I can guide someone to do it.)I was able to do it, see https://github.com/ODM2/WOFpy/settings/keys
(My super powers here are still valid ;-p)
Preview: