Docs

[ocefpaf]

Some problems I found when building the docs:

• missing image graphics/companylogos.png;
• documents present but not used: ODM1Services.rst, ODM2Services.rst and changes.rst;
• several linkcheck failures (run make 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 with doctr 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:

[emiliom]

Some problems I found when building the docs:

* missing image `graphics/companylogos.png`;
* documents present but not used: `ODM1Services.rst`, `ODM2Services.rst` and `changes.rst`;
* several `linkcheck` failures (run `make linkcheck` to see the URLs that are failing but many are "dummy" URLs and should be marked as expected failures).

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.

Note that I added an automatic build and upload with doctr

Ah. I'd never heard of https://github.com/drdoctr/doctr. Thanks.

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 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.

Preview:

Thanks!

[emiliom]

I was able to do it, see https://github.com/ODM2/WOFpy/settings/keys

👍

(My super powers here are still valid ;-p)

I plan to keep it that way, unless you go to the dark side ...

[emiliom]

This PR addresses #233

[ocefpaf]

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.

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 doctr tries to push to gh-pages.)

[ocefpaf]

BTW, I fixed a few test failures too. Nothing major, just updates.

[emiliom]

BTW, I fixed a few test failures too. Nothing major, just updates.

Yup, I saw that.

[emiliom]

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 conda.recipe directory, shouldn't we remove the directory as well, or will it be removed automatically?

[ocefpaf]

You removed /conda.recipe/meta.yaml@master. I trust you on that one, since I don't know better. But since that's the only file in the conda.recipe directory, shouldn't we remove the directory as well, or will it be removed automatically?

The directory is also removed (git does not allow for empty directories). The tests are now all on the .appveyor.yml and they don't need conda-build to run.

[ocefpaf]

@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.

[emiliom]

It's good to go.

[emiliom]

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.

[ocefpaf]

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