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

Remove automatically generated files from doc/reference. #26

Merged
merged 4 commits into from
Apr 20, 2016

Conversation

arokem
Copy link
Contributor

@arokem arokem commented Mar 29, 2016

No description provided.

@arokem
Copy link
Contributor Author

arokem commented Mar 29, 2016

@andim: Does this look about right?

@andim
Copy link
Contributor

andim commented Mar 30, 2016

There seems to be a further issue, which is that right now in the Makefile only html is dependent on the api reference generation, whereas all the other output formats also need it. This could be fixed in the Makefile.

More severly: If you handle the dependency via the Makefile I run into trouble with readthedocs as it does not know that it should generate the references!

Therefore a probably nicer way to handle the api reference generation is to let it be generated directly from conf.py. I hacked together such a solution in andim/noisyopt@13541ac. Comments welcome :)

@andim andim mentioned this pull request Mar 31, 2016
@arokem
Copy link
Contributor Author

arokem commented Apr 1, 2016

Would you mind making a PR with this?

@andim
Copy link
Contributor

andim commented Apr 2, 2016

Sure, see PR #28

@arokem arokem force-pushed the doc-reference-empty branch from ff8cb6e to 6c214f9 Compare April 20, 2016 15:41
@arokem
Copy link
Contributor Author

arokem commented Apr 20, 2016

Now, with #28 merged, is it a good time to merge this one as well?

@andim
Copy link
Contributor

andim commented Apr 20, 2016

I don't see why not!

@arokem arokem merged commit 48ffcba into uwescience:master Apr 20, 2016
@arokem
Copy link
Contributor Author

arokem commented Apr 20, 2016

Thanks!

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

Successfully merging this pull request may close these issues.

2 participants