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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ matrix:
sudo: true

install:
- pip install --upgrade pytest
- pip install -r requirements-test.txt
- pip install codecov
script: py.test --cov=flit
- python3 -m pip install --upgrade pip
- python3 -m pip install --upgrade -r requirements-test.txt
- python3 -m flit install --deps develop
- 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?

after_success: codecov
sudo: false
3 changes: 3 additions & 0 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ environment:
- PYTHON: "C:\\Python36"

install:
- "%PYTHON%\\python.exe -m pip install --upgrade pip codecov"
- "%PYTHON%\\python.exe -m pip install -r requirements-test.txt"
- "%PYTHON%\\python.exe -m flit install --deps develop"

build: off

test_script:
- "%PYTHON%\\python.exe -m pytest"
- "sphinx-build -b html -d _build\\doctrees doc _build\\html"
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
# built documents.
#
# The short X.Y version.
version = '1.1'
version = '1.2.dev0'
# The full version, including alpha/beta/rc tags.
release = version #+ '.1'

Expand Down
2 changes: 1 addition & 1 deletion doc/upload.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Using environment variables
You can specify a server to upload to with :envvar:`FLIT_INDEX_URL`, and
pass credentials with :envvar:`FLIT_USERNAME` and :envvar:`FLIT_PASSWORD`.
Environment variables take precedence over the config file, except if you use
the :option:`--repository` option to explicitly pick a server from the config file.
the :option:`flit --repository` option to explicitly pick a server from the config file.

This can make it easier to automate uploads, for example to release packages
from a continuous integration job.
Expand Down
2 changes: 1 addition & 1 deletion flit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from . import common
from .log import enable_colourful_output

__version__ = '1.1'
__version__ = '1.2.dev0'

log = logging.getLogger(__name__)

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ test = [
"pytest-cov",
]
doc = [
"pygments-github-lexers", # TOML highlighting
"pygments-github-lexers", # TOML highlighting
"sphinx",
]

[tool.flit.metadata.urls]
Expand Down
2 changes: 1 addition & 1 deletion requirements-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ zipfile36
pytoml
pytest>=2.7.3
pytest-warnings
pytest-cov
pytest-cov