search

Wikidata / soweego

Link Wikidata items to large catalogs
https://meta.wikimedia.org/wiki/Grants:Project/Hjfocs/soweego_2
GNU General Public License v3.0
97 stars 9 forks source link

No display of the Wikidata bot in the Sphinx documentation #387

Closed marfox closed 3 years ago

marfox commented 3 years ago

See https://soweego.readthedocs.io/en/latest/ingester.html#module-soweego.ingester Docstrings seem there: https://github.com/Wikidata/soweego/blob/020a792add1ea2572358da671c7900222a146966/soweego/ingester/wikidata_bot.py

tupini07 commented 3 years ago

@marfox I tried building the documentation locally and I also experienced the same issue you mentioned (ingester.wikidata_bot has no module documentation).

However, while building the doc I noticed that Sphinx was complaining about it not being able to find some dependencies. Once I installed the missing dependencies the documentation got generated correctly.

Do you know where are we generating the documentation for https://soweego.readthedocs.io/ ? Is it with TravisCI?

I think the first step is to check whether the env building the doc has the required dependencies from requirements.txt :smile:

marfox commented 3 years ago

Thanks a lot for your reaction! The documentation build happens at readthedocs.org, see for instance https://readthedocs.org/projects/soweego/builds/10741570/

If I remember correctly, a new build is triggered when the master branch is updated.

I think I've never touched the readthedocs build script, so I guess we should have a look there.

Il mer 5 mag 2021, 01:10 Andrea Tupini @.***> ha scritto:

@marfox https://github.com/marfox I tried building the documentation locally and I also experienced the same issue you mentioned ( ingester.wikidata_bot has no module documentation).

However, while building the doc I noticed that Sphinx was complaining about it not being able to find some dependencies. Once I installed the missing dependencies the documentation got generated correctly.

Do you know where are we generating the documentation for https://soweego.readthedocs.io/ ? Is it with TravisCI?

I think the first step is to check whether the env building the doc has the required dependencies from requirements.txt 😄

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Wikidata/soweego/issues/387#issuecomment-832334296, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABE5HKE3PK5GHT4H4DJXHVDTMCEHNANCNFSM44A7KYHA .

marfox commented 3 years ago

Fixed