search

rl-institut / WAM

Django server for adding multiple (map) apps
https://wam.readthedocs.io
GNU Affero General Public License v3.0
6 stars 1 forks source link

RTD documentation for apps #47

Closed nesnoj closed 5 years ago

nesnoj commented 5 years ago

There're WAM docs in place on RTD that cover the WAM itself without apps or API. Now I'd like to add one for my app.

I created some sphinx docs and want the API to be included. Usually, for packages you (or RTD) create it using sphinx-apidoc pretty straightforward or it is invoked automatically by including the sphinx.autodoc module.

As our apps need the WAM (more precisely, the django config), it's a little more complicated. After some research (there're heaps of how-tos on sphinx & django but just a few mention docs for django apps only) I added some manual config which works locally but RTD throws import errors.

So I tried to add the WAM package to a RTD requirements file which includes git+https://github.com/rl-institut/WAM@master#egg=wam but apparently we do not have a setup.py yet.

I'd like to add one to allow for the WAM installation. Any objections or hints, @rl-institut/wam-team? Alternatively, there might be better solutions I'm not aware of? Has anyone of you worked with sphinx and standalone django apps before?

christian-rli commented 5 years ago

I have no objections re packaging, but no hints either.

Bachibouzouk commented 5 years ago

Could django-sphinxdoc help? I unfortunately didn't work with sphinx and standalone django apps before :(

4lm commented 5 years ago

Good idea, making the WAM installable via setup.py, we than could make it even installable as PYPI-Package! I have only little experience with setting up setup.py's.

I'd like to add one to allow for the WAM installation. Any objections or hints, @rl-institut/wam-team?

No objections. No hints.

Alternatively, there might be better solutions I'm not aware of?

Don't know of any viable alternatives, going the setup.py route seems the way to go.

Has anyone of you worked with sphinx and standalone django apps before?

No.

nesnoj commented 5 years ago

Thanks for the comments. I'll create a setup.py in a new branch soon. New issue: #49

@Bachibouzouk django-sphinxdoc seems to be for integration of docs into the django project i.e. providing our docs on the WAM server - I like this idea, we could talk about it again later, for now I'd leave it on RTD..

I leave this open until we've found and documented a proper solution..

nesnoj commented 5 years ago

Fixed in #82 :rocket: