Skip to content

Perform 'blurb split' for master. #2719

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

Closed
wants to merge 13 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ matrix:
# Sphinx is pinned so that new versions that introduce new warnings won't suddenly cause build failures.
# (Updating the version is fine as long as no warnings are raised by doing so.)
- python -m pip install sphinx~=1.6.1
- python -m pip install blurb
Copy link
Member

Choose a reason for hiding this comment

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

Suggest something like:
- python -m pip install 'blurb>=1.0.2dev1'

Copy link
Member

Choose a reason for hiding this comment

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

@larryhastings did you push this version? If so, was keeping the dev version on purpose or an accident? If the latter we can just fix the version number and do another release as 1.0.2 so the dependency can be >=1.0.2.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I pushed this version. I don't remember what I changed. I didn't keep the "dev" version on purpose, but then again it is still a little bit under development.

Copy link
Member

@brettcannon brettcannon Jul 22, 2017

Choose a reason for hiding this comment

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

Blurb is under development but is the 1.0.2 release specifically under development? My assumption is you mean the former and not the latter, which means I can push a 1.0.2 release so that the changes in that bugfix release go public because right now no one is getting access since pip considers a dev release unusable without opting in.

script:
- make check suspicious html SPHINXOPTS="-q -W -j4"
- os: linux
Expand Down Expand Up @@ -109,3 +110,4 @@ notifications:
on_success: change
on_failure: always
skip_join: true

5 changes: 4 additions & 1 deletion Doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ help:
@echo " serve to serve the documentation on the localhost (8000)"

build:
-mkdir build
Copy link
Member

Choose a reason for hiding this comment

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

A more common idiom for this is mkdir -p build. That has the advantage of not producing any messages if the directory already exists.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

blurb merge -f build/NEWS
Copy link
Member

Choose a reason for hiding this comment

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

To get around the PATH problem, suggest:

  1. Adding
    BLURB = $(PYTHON) -m blurb
    after line 8 (SPHINXBUILD = sphinx-build) in the definitions at the top of the file and then
  2. changing the line above to:
    $(BLURB) merge -f build/NEWS
    That way, if users do a make venv ; make html PYTHON=venv/bin/python, blurb will be found there but, if they need to use a different version of blurb, they can override it: make html BLURB=/usr/local/bin/blurb.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

$(SPHINXBUILD) $(ALLSPHINXOPTS)
@echo

Expand Down Expand Up @@ -107,7 +109,7 @@ clean:

venv:
$(PYTHON) -m venv venv
./venv/bin/python3 -m pip install -U Sphinx
./venv/bin/python3 -m pip install -U Sphinx blurb
Copy link
Member

Choose a reason for hiding this comment

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

As above, suggest setting a version requirement here:
./venv/bin/python3 -m pip install -U Sphinx 'blurb>=1.0.2dev1'
That should be future-proof.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


dist:
rm -rf dist
Expand Down Expand Up @@ -189,3 +191,4 @@ autobuild-stable-html:
exit 1;; \
esac
@make autobuild-dev-html

2 changes: 1 addition & 1 deletion Doc/whatsnew/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
Changelog
+++++++++

.. miscnews:: ../../Misc/NEWS
.. miscnews:: ../build/NEWS
Loading