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

Fix warnings when building the documentation. #201

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Mariatta
Copy link
Contributor

Fix the warning related to --repository option.
Add sphinx to requirements-test.
Run make html as part of travis CI.

Closes #189

Fix the warning related to `--repository` option.
Add sphinx to requirements-test.
Run `make html` as part of travis CI.

Closes pypa#189
@Mariatta Mariatta changed the title Fix warnings when building the documentation. (wip) Fix warnings when building the documentation. Aug 28, 2018
.travis.yml Outdated
- pip install --upgrade pytest
- pip install -r requirements-test.txt
- pip install --upgrade pip flit
- flit install --deps develop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than installing flit from PyPI, let's use python3 -m flit to use the master copy of flit for this.

@Mariatta
Copy link
Contributor Author

Hmm, why wouldn't python3 -m flit install --deps develop install sphinx, a doc extras?

@Carreau
Copy link
Contributor

Carreau commented Aug 30, 2018

Hmm, why wouldn't python3 -m flit install --deps develop install sphinx, a doc extras?

From the logs it logs like it pulls pyproject.toml from the pip-installed flit.
Try to bump version in __init__ to 1.1.dev ?

@Mariatta
Copy link
Contributor Author

Ah, I see. Do you think 1.1.post0 would make more sense?
Or 1.2.dev0?
I think it should also be its own change, separate from this PR.

@Carreau
Copy link
Contributor

Carreau commented Aug 30, 2018 via email

@Mariatta
Copy link
Contributor Author

Thanks, tested on my machine, and bumping the release number fixed it.

@Mariatta
Copy link
Contributor Author

This is now passing on Travis Python v3.6 and 3.7. I don't know what the problem is with Python 3.5, 3.4. Will look into it later.

@Carreau
Copy link
Contributor

Carreau commented Aug 30, 2018

It's and installation issue. zipfile36 does not get installed on 3.4 and 3.5.
They are not installed anymore. I can try to fix that for you.

@Carreau
Copy link
Contributor

Carreau commented Aug 30, 2018

All green on travis ! 🥇to @Mariatta !

Appveyor seem to have hit a random error.

@Carreau
Copy link
Contributor

Carreau commented Aug 30, 2018

Appveyor seem to have hit a random error.

(and I'm not allowed to restart...)

@Mariatta
Copy link
Contributor Author

Thanks @Carreau. Yeah we've seen that strange error on appveyor before ☹️

I was wondering we can move all dependencies from requirements-test into "test" extras in pyproject.toml, and not rely on requirements-test anymore.
But I think that's out of the scope of this PR :)

@Mariatta Mariatta changed the title (wip) Fix warnings when building the documentation. Fix warnings when building the documentation. Aug 30, 2018
- python3 -m pip install codecov
script:
- py.test --cov=flit
- sphinx-build -b html -d _build/doctrees doc _build/html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're trying to verify that it builds without warnings, I think you need the -W flag to turn warnings into errors.

Also, could we do this inside an if so it only builds the docs on one version of Python?

@takluyver
Copy link
Member

I'm trying push flit forwards a bit. I've got the docs building without warnings now, with a slightly different approach.

If you're still interested in this (or anyone else reading this), I'd still be interested in having a convenient way to check that the docs build without warnings. Now it would make sense to integrate that into the tox config.

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.

Some warnings when building the docs
3 participants