search

bitprophet / releases

A powerful Sphinx changelog-generating extension.
http://releases.readthedocs.io/
BSD 2-Clause "Simplified" License
176 stars 41 forks source link

Unable to build -- Unknown node "issue" #22

Closed prologic closed 10 years ago

prologic commented 10 years ago

Hi despite having releases in the extensions list of my docs/source.conf.py I get the following error:

pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 31%] changes                                                                                                                                
Exception occurred:
  File "/home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages/sphinx/writers/html.py", line 588, in unknown_visit
    raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
NotImplementedError: Unknown node: issue
The full traceback has been saved in /tmp/sphinx-err-8G5mEk.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1

Fatal error: local() encountered an error (return code 2) while executing 'make html'

Aborting.
prologic commented 10 years ago

Versions of things:

$ pip freeze
Fabric==1.8.2
Jinja2==2.7.2
MarkupSafe==0.18
Pygments==1.6
Sphinx==1.2.2
Sphinx-PyPI-upload==0.2.1
docutils==0.11
ecdsa==0.10
paramiko==1.12.2
pycrypto==2.6.1
releases==0.5.1
sphinxcontrib-googleanalytics==0.1
sphinxcontrib-programoutput==0.8
wsgiref==0.1.2
bitprophet commented 10 years ago

@therealprologic Can you share the contents of your changelog.rst?

I'm debugging an instance of this myself in one specific spot but a) only on master, 0.5.1 worked ok for the changelog I'm testing, and b) it's specific to a no-number issue (aka a plain bullet list item with no :bug:, :support: etc role at the start.

prologic commented 10 years ago

CHANGES.rst:

Changes
-------

circuits-3.0.dev
................

- Fixed a bug with Web Sockets preventing initial data in the Response (Issue #53)
bitprophet commented 10 years ago

Hm, yea perhaps the bug I just fixed re: that kind of line (see github auto link) has been around longer than I thought (I am trying to figure out why its regression test wasn't failing, right now).

If you can, try nabbing latest master, just pushed something that fixed it in my situation.

That aside, looking at your example, you might want to revisit the usage/concepts docs at http://releases.readthedocs.org/en/latest/ - you don't want to be putting in your own headers for releases :) just one timeline & releases will parse it out for you. And no need for a .dev "release" item either - Releases will automatically generate an 'unreleased' entry for anything not followed by a release line.

prologic commented 10 years ago

Oh yeah, I wasn't even trying to convert my crappy change log yet, just trying out rleases and found something wasn't quite right! Hence the reported issue :/

bitprophet commented 10 years ago

Well, you probably did still hit a real bug, though things might've looked funny if it had fully completed :D but yea Releases is a relatively specific "put everything in a timeline format, run parse magic, enjoy rendered results" workflow, it's not designed to take an existing changelog and do anything useful with that.

prologic commented 10 years ago

Gah terribly sorry. I had that change shelved. This is the actual content of my CHANGES.rst file:

:orphan:

Changes
-------

- :bug:`53` Fixed bug with Web Sockets preventing initial data in the Response

Older Change Logs
-----------------

For older Change Logs of previous versions of circuits please see the respective `PyPi <http://pypi.python.org/pypi>`_ page(s):

- `circuits-2.1.0 <http://pypi.python.org/pypi/circuits/2.1.0>`_
- `circuits-2.0.1 <http://pypi.python.org/pypi/circuits/2.0.1>`_
- `circuits-2.0.0 <http://pypi.python.org/pypi/circuits/2.0.0>`_
- `circuits-1.6 <http://pypi.python.org/pypi/circuits/1.6>`_
- `circuits-1.5 <http://pypi.python.org/pypi/circuits/1.5>`_
prologic commented 10 years ago

Precisely. I did adapt my changelog to suit :) I don't think I missed anything with the above (2nd paste?)

cheers James

James Mills / prologic

E: prologic@shortcircuit.net.au W: prologic.shortcircuit.net.au

On Sat, Mar 15, 2014 at 8:47 AM, Jeff Forcier notifications@github.comwrote:

Well, you probably did still hit a real bug, though things might've looked funny if it had fully completed :D but yea Releases is a relatively specific "put everything in a timeline format, run parse magic, enjoy rendered results" workflow, it's not designed to take an existing changelog and do anything useful with that.

— Reply to this email directly or view it on GitHubhttps://github.com/bitprophet/releases/issues/22#issuecomment-37705316 .

prologic commented 10 years ago

I get the same problem with the latest master branch too btw?

prologic@daisy
Sat Mar 15 08:57:25
~/circuits
$ fab docs
[localhost] local: pip install -U -r docs/requirements.txt
Requirement already up-to-date: Sphinx in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 1))
Obtaining releases from git+https://github.com/bitprophet/releases.git#egg=releases (from -r docs/requirements.txt (line 3))
  Cloning https://github.com/bitprophet/releases.git to /home/prologic/.virtualenvs/circuits/src/releases
  Running setup.py egg_info for package releases

Requirement already up-to-date: Sphinx-PyPI-upload in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 4))
Requirement already up-to-date: sphinxcontrib-programoutput in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 5))
Requirement already up-to-date: sphinxcontrib-googleanalytics in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 6))
Requirement already up-to-date: Pygments>=1.2 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: docutils>=0.7 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: Jinja2>=2.3 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: markupsafe in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Jinja2>=2.3->Sphinx->-r docs/requirements.txt (line 1))
Installing collected packages: releases
  Running setup.py develop for releases

    Creating /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages/releases.egg-link (link to .)
    Adding releases 0.5.2 to easy-install.pth file

    Installed /home/prologic/.virtualenvs/circuits/src/releases
Successfully installed releases
Cleaning up...
[localhost] local: make html
sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.2.2
loading pickled environment... not yet created
building [html]: targets for 45 source files that are out of date
updating environment: 45 added, 0 changed, 0 removed
reading sources... [100%] web/miscellaneous                                                                                                                     
/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.generate_events:8: WARNING: Inline emphasis start-string without end-string.
/home/prologic/work/circuits/docs/source/examples/index.rst:5: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/hello.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:17: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/echoserver.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:29: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/helloweb.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:10: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/hello.py
/home/prologic/work/circuits/docs/source/examples/index.rst:22: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/echoserver.py
/home/prologic/work/circuits/docs/source/examples/index.rst:34: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/helloweb.py
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/v/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/d/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://jenkins.shiningpanda-ci.com/prologic/job/circuits/badge/icon
../README.rst:None: WARNING: nonlocal image URI found: https://requires.io/bitbucket/circuits/circuits-dev/requirements.png?branch=default
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/v/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/d/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://jenkins.shiningpanda-ci.com/prologic/job/circuits/badge/icon
../README.rst:None: WARNING: nonlocal image URI found: https://requires.io/bitbucket/circuits/circuits-dev/requirements.png?branch=default
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 31%] changes                                                                                                                                
Exception occurred:
  File "/home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages/sphinx/writers/html.py", line 588, in unknown_visit
    raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
NotImplementedError: Unknown node: issue
The full traceback has been saved in /tmp/sphinx-err-fTp3KY.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1

Fatal error: local() encountered an error (return code 2) while executing 'make html'

Aborting.
prologic commented 10 years ago

Just to be sure, I nuked my virtualenv, re-created a new blank one just in case the master branch didn't install over the top of the pip-instaleld prior version :)

prologic commented 10 years ago

CHANGES.rst now looks like this: http://codepad.org/gN8HKbYz

bitprophet commented 10 years ago

Yea I just pasted your earlier paste over my real changelog and got the same error. Bizarre! I'll see if I can figure out what the deal is, hopefully it's something silly and simple to fix. Thanks a lot for the reports :)

prologic commented 10 years ago

No problems at all! Glad I can help!

cheers James

James Mills / prologic

E: prologic@shortcircuit.net.au W: prologic.shortcircuit.net.au

On Sat, Mar 15, 2014 at 10:16 AM, Jeff Forcier notifications@github.comwrote:

Yea I just pasted your earlier paste over my real changelog and got the same error. Bizarre! I'll see if I can figure out what the deal is, hopefully it's something silly and simple to fix. Thanks a lot for the reports :)

— Reply to this email directly or view it on GitHubhttps://github.com/bitprophet/releases/issues/22#issuecomment-37709621 .

bitprophet commented 10 years ago

Heh, I was looking way too closely at this! The problem is that Releases has to hook into Sphinx in a couple of places, and the parse step which generates real HTML-friendly objects, only runs on files named changelog.rst - so your CHANGES.rst is not triggering that.

Unfortunately we can't similarly limit the initial parsing step of :bug: -> an issue object - so that's why the error is kind of unfriendly: Sphinx's regular parsing stuff is hitting objects intended to only stick around in the middle of the process.

I think the best solution instead is to let you configure Releases to tell it where your changelog is. I'll poke at this soon and let you know when there's a branch you can try out. Thanks for your patience!

bitprophet commented 10 years ago

I will also check to see if I can tell sphinx to spit out a nicer error message for those roles, though that's a long shot.

prologic commented 10 years ago

Ahhh now that makes sense. But it's kinda silly to limit just to a hard coded filename isn't it? :)

Look forward to the enhancement!

cheers James

James Mills / prologic

E: prologic@shortcircuit.net.au W: prologic.shortcircuit.net.au

On Sat, Mar 15, 2014 at 11:35 AM, Jeff Forcier notifications@github.comwrote:

I will also check to see if I can tell sphinx to spit out a nicer error message for those roles, though that's a long shot.

— Reply to this email directly or view it on GitHubhttps://github.com/bitprophet/releases/issues/22#issuecomment-37712021 .

bitprophet commented 10 years ago

Not silly, sadly, because there was no good way to implement this besides "find the first bulleted list in a specific document" :( One certainly doesn't want all bullet lists getting this treatment...

Could probably find an alternate way later (e.g. have a sentinel role/directive) but at the time this made the most sense (especially as it was adapting an existing setup.)

prologic commented 10 years ago

Well I think the configurable filename is a good alternative.

releases_changelog_filename option in the conf.py

cheers James

James Mills / prologic

E: prologic@shortcircuit.net.au W: prologic.shortcircuit.net.au

On Sat, Mar 15, 2014 at 4:39 PM, Jeff Forcier notifications@github.comwrote:

Not silly, sadly, because there was no good way to implement this besides "find the first bulleted list in a specific document" :( One certainly doesn't want all bullet lists getting this treatment...

Could probably find an alternate way later (e.g. have a sentinel role/directive) but at the time this made the most sense (especially as it was adapting an existing setup.)

— Reply to this email directly or view it on GitHubhttps://github.com/bitprophet/releases/issues/22#issuecomment-37718853 .

bitprophet commented 10 years ago

Yup, that is the easiest option for sure :D

prologic commented 10 years ago

Any progress on this? I tried to see if I could implement this quickly to save you some time/effort -- sadly I don't know enough about the internals of sphinx to do it without an interactive debugger :/

bitprophet commented 10 years ago

Just been busy elsewhere, but I am poking at other Releases things this AM so will see if I can squeeze it in. Thanks!

prologic commented 10 years ago

No problems :)

James Mills / prologic

E: prologic@shortcircuit.net.au W: prologic.shortcircuit.net.au

On Wed, Apr 2, 2014 at 4:59 AM, Jeff Forcier notifications@github.comwrote:

Just been busy elsewhere, but I am poking at other Releases things this AM so will see if I can squeeze it in. Thanks!

— Reply to this email directly or view it on GitHubhttps://github.com/bitprophet/releases/issues/22#issuecomment-39244625 .

bitprophet commented 10 years ago

@therealprologic Just pushed this to master, if you want to check it out. Simply add releases_document_name = "CHANGES" to conf.py and it ought to work? :)

prologic commented 10 years ago

Hmm still having the same problem

prologic@daisy
Fri Apr 04 07:58:08
~/circuits
$ fab docs.clean docs.build
[localhost] local: make clean
rm -rf build/*
[localhost] local: pip install -U -r docs/requirements.txt
Requirement already up-to-date: Sphinx in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 1))
Obtaining releases from git+https://github.com/bitprophet/releases.git#egg=releases (from -r docs/requirements.txt (line 3))
  Updating /home/prologic/.virtualenvs/circuits/src/releases clone
  Running setup.py egg_info for package releases

Requirement already up-to-date: Sphinx-PyPI-upload in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 4))
Requirement already up-to-date: sphinxcontrib-programoutput in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 5))
Requirement already up-to-date: sphinxcontrib-googleanalytics in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 6))
Requirement already up-to-date: Pygments>=1.2 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: docutils>=0.7 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: Jinja2>=2.3 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: markupsafe in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Jinja2>=2.3->Sphinx->-r docs/requirements.txt (line 1))
Installing collected packages: releases
  Running setup.py develop for releases

    Creating /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages/releases.egg-link (link to .)
    releases 0.5.3 is already the active version in easy-install.pth

    Installed /home/prologic/.virtualenvs/circuits/src/releases
Successfully installed releases
Cleaning up...
[localhost] local: make html
sphinx-build -b html -d build/doctrees   source build/html
Making output directory...
Running Sphinx v1.2.2
loading pickled environment... not yet created
building [html]: targets for 45 source files that are out of date
updating environment: 45 added, 0 changed, 0 removed
reading sources... [100%] web/miscellaneous
/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.generate_events:8: WARNING: Inline emphasis start-string without end-string.
/home/prologic/work/circuits/docs/source/examples/index.rst:5: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/hello.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:17: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/echoserver.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:29: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/helloweb.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:10: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/hello.py
/home/prologic/work/circuits/docs/source/examples/index.rst:22: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/echoserver.py
/home/prologic/work/circuits/docs/source/examples/index.rst:34: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/helloweb.py
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/v/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/d/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://jenkins.shiningpanda-ci.com/prologic/job/circuits/badge/icon
../README.rst:None: WARNING: nonlocal image URI found: https://requires.io/bitbucket/circuits/circuits-dev/requirements.png?branch=default
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/v/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/d/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://jenkins.shiningpanda-ci.com/prologic/job/circuits/badge/icon
../README.rst:None: WARNING: nonlocal image URI found: https://requires.io/bitbucket/circuits/circuits-dev/requirements.png?branch=default
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 31%] changes
Exception occurred:
  File "/home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages/sphinx/writers/html.py", line 588, in unknown_visit
    raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
NotImplementedError: Unknown node: issue
The full traceback has been saved in /tmp/sphinx-err-VCPX8o.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1

Fatal error: local() encountered an error (return code 2) while executing 'make html'

Aborting.
prologic commented 10 years ago

This branch of circuits is here: https://bitbucket.org/prologic/circuits/commits/branch/Issue78

bitprophet commented 10 years ago

Hah, my tests were still not high level enough :( I see what it is now, my assumption was that the docutils doctree name reflected the filename, but it is instead a .lower() or something of the top level title/header. (In my default case, the two are the same - changelog.rst + Changelog.)

Poking to see if we can actually obtain the document name now since that's clearly more useful.

prologic commented 10 years ago

Ahhh :) Well glad I can help (sort of)!

Let me know how it goes!

cheers James

James Mills / prologic

E: prologic@shortcircuit.net.au W: prologic.shortcircuit.net.au

On Fri, Apr 4, 2014 at 8:36 AM, Jeff Forcier notifications@github.comwrote:

Hah, my tests were still not high level enough :( I see what it is now, my assumption was that the docutils document name reflected the filename, but it is instead a .lower() or something of the top level title/header. (In my default case, the two are the same - changelog.rst + Changelog.)

Poking to see if we can actually obtain the document name now since that's clearly more useful.

— Reply to this email directly or view it on GitHubhttps://github.com/bitprophet/releases/issues/22#issuecomment-39513538 .

bitprophet commented 10 years ago

Found out the right way to do this, so will release that today, just need to rejigger the tests to be truly 100% integration level - clearly trying to be efficient and rely on mocking is going to miss things on occasion :(

bitprophet commented 10 years ago

OK, pushing 0.6.1 with the fix now, please give it a shot!

prologic commented 10 years ago

Will do!

James Mills / prologic

E: prologic@shortcircuit.net.au W: prologic.shortcircuit.net.au

On Mon, Apr 7, 2014 at 3:54 AM, Jeff Forcier notifications@github.comwrote:

OK, pushing 0.6.1 with the fix now, please give it a shot!

— Reply to this email directly or view it on GitHubhttps://github.com/bitprophet/releases/issues/22#issuecomment-39674933 .

prologic commented 10 years ago

Success!

$ fab docs.clean docs.build
[localhost] local: make clean
rm -rf build/*
[localhost] local: pip install -U -r docs/requirements.txt
Requirement already up-to-date: Sphinx in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 1))
Obtaining releases from git+https://github.com/bitprophet/releases.git#egg=releases (from -r docs/requirements.txt (line 3))
  Updating /home/prologic/.virtualenvs/circuits/src/releases clone
  Running setup.py egg_info for package releases

Requirement already up-to-date: Sphinx-PyPI-upload in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 4))
Requirement already up-to-date: sphinxcontrib-programoutput in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 5))
Requirement already up-to-date: sphinxcontrib-googleanalytics in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from -r docs/requirements.txt (line 6))
Requirement already up-to-date: Pygments>=1.2 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: docutils>=0.7 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: Jinja2>=2.3 in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Sphinx->-r docs/requirements.txt (line 1))
Requirement already up-to-date: markupsafe in /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages (from Jinja2>=2.3->Sphinx->-r docs/requirements.txt (line 1))
Installing collected packages: releases
  Running setup.py develop for releases

    Creating /home/prologic/.virtualenvs/circuits/lib/python2.7/site-packages/releases.egg-link (link to .)
    Adding releases 0.6.1 to easy-install.pth file

    Installed /home/prologic/.virtualenvs/circuits/src/releases
Successfully installed releases
Cleaning up...
[localhost] local: make html
sphinx-build -b html -d build/doctrees   source build/html
Making output directory...
Running Sphinx v1.2.2
loading pickled environment... not yet created
building [html]: targets for 45 source files that are out of date
updating environment: 45 added, 0 changed, 0 removed
<bug #53>ources... [ 31%] changes
Adding to 'unreleased_bugfix'
Creating 'unreleased_bugfix' faux-release with [<bug #53>]
Creating 'unreleased_feature' faux-release with []
reading sources... [100%] web/miscellaneous
/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.generate_events:8: WARNING: Inline emphasis start-string without end-string.
/home/prologic/work/circuits/docs/source/examples/index.rst:5: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/hello.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:17: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/echoserver.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:29: WARNING: Include file u'/home/prologic/work/circuits/docs/source/examples/examples/helloweb.py' not found or reading it failed
/home/prologic/work/circuits/docs/source/examples/index.rst:10: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/hello.py
/home/prologic/work/circuits/docs/source/examples/index.rst:22: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/echoserver.py
/home/prologic/work/circuits/docs/source/examples/index.rst:34: WARNING: download file not readable: /home/prologic/work/circuits/docs/source/examples/examples/helloweb.py
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/v/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/d/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://jenkins.shiningpanda-ci.com/prologic/job/circuits/badge/icon
../README.rst:None: WARNING: nonlocal image URI found: https://requires.io/bitbucket/circuits/circuits-dev/requirements.png?branch=default
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/v/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://pypip.in/d/circuits/badge.png
../README.rst:None: WARNING: nonlocal image URI found: https://jenkins.shiningpanda-ci.com/prologic/job/circuits/badge/icon
../README.rst:None: WARNING: nonlocal image URI found: https://requires.io/bitbucket/circuits/circuits-dev/requirements.png?branch=default
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] web/miscellaneous
/home/prologic/work/circuits/docs/source/api/circuits.core.rst:64: WARNING: more than one target found for cross-reference u'fireEvent': circuits.core.Manager.fireEvent, circuits.core.manager.Manager.fireEvent
/home/prologic/work/circuits/docs/source/api/circuits.core.rst:89: WARNING: more than one target found for cross-reference u'fireEvent': circuits.core.Manager.fireEvent, circuits.core.manager.Manager.fireEvent
writing additional files... genindex py-modindex search
copying images... [100%] web/../images/CircuitsWebServer.png
copying downloadable files... [100%] /home/prologic/work/circuits/docs/source/examples/hello.py
copying static files... done
copying extra files... done
dumping search index... done
dumping object inventory... done
build succeeded, 17 warnings.

Build finished. The HTML pages are in build/html.

Done.

And here's the result:

http://arrow.shortcircuit.net.au:9000/changes.html

PS: What determines whether the next release is a bugfix release or major/minor release?

bitprophet commented 10 years ago

Belated reply, @therealprologic - with small projects like this it's kind of arbitrary as I don't keep multiple release branches around, so it comes down to the perceived "size" of the updates and whether they're clearly fixing brokenness or are clearly wholly new features. Things like this fall in the middle so it's really a coin flip.