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: API reference at python-cerberus.org lacks generated contents #281

Closed
funkyfuture opened this Issue Nov 11, 2016 · 7 comments

Comments

Projects
None yet
2 participants
@funkyfuture
Copy link
Member

funkyfuture commented Nov 11, 2016


Bug report

i just noticed that these generated includes of the docs do not appear in the online docs while they do in a local build:

http://docs.python-cerberus.org/en/stable/api.html#error-codes
http://docs.python-cerberus.org/en/stable/api.html#schema-validation-schema

@funkyfuture funkyfuture changed the title docs: API reference docs: API reference at python-cerberus.org lacks generated contents Nov 11, 2016

@nicolaiarocci nicolaiarocci added this to the Unreleased milestone Nov 12, 2016

@funkyfuture

This comment has been minimized.

Copy link
Member

funkyfuture commented Dec 10, 2016

is the checkbox "Install your project inside a virtualenv using setup.py install" checked in the Advanced Settings of the RtD-project? if not and checking it solves the issue, maybe the call to docs/includes/generate.py should be in conf.py rather than in the Makefile to let the build fail if there's a problem.

@nicolaiarocci

This comment has been minimized.

Copy link
Member

nicolaiarocci commented Jan 17, 2017

Yes the checkbox is checked now (it wasn't), but it does not seem to solve the issue.

@nicolaiarocci nicolaiarocci removed this from the Unreleased milestone Jan 25, 2017

@funkyfuture

This comment has been minimized.

Copy link
Member

funkyfuture commented Jul 4, 2017

now it also seems to affect builds on travis.

@funkyfuture

This comment has been minimized.

Copy link
Member

funkyfuture commented Jul 4, 2017

maybe a git-hook that updates the then repo-included assets is the most durable solution?

@nicolaiarocci

This comment has been minimized.

Copy link
Member

nicolaiarocci commented Jul 22, 2017

Seems odd to me that only py35 is affected on travis.

@funkyfuture

This comment has been minimized.

Copy link
Member

funkyfuture commented Jul 22, 2017

that is because the doctests run on it: https://github.com/pyeve/cerberus/blob/master/tox.ini#L36

@funkyfuture

This comment has been minimized.

Copy link
Member

funkyfuture commented Aug 19, 2017

i pledge to mark this for the 1.2 milestone.

@nicolaiarocci nicolaiarocci added this to the 1.2 milestone Aug 20, 2017

nicolaiarocci added a commit that referenced this issue Aug 28, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment