Skip to content

Conversation

mtreinish
Copy link
Member

Summary

This change starts the process of preparing the documentation for the
0.7 release. It adds detailed release notes and updates and cleans up
somethings in the changelog.

Details and comments

Fixes #1370

@diego-plan9
Copy link
Member

While checking the release notes and changelog, can we take a pass at fixing the Sphinx warnings in those docs? There are a bunch of:

doc/CHANGELOG.rst:540: WARNING: Title underline too short.

which should be just a matter of fixing the number of symbols, and also a number of:

CHANGELOG.rst:23: WARNING: Title level inconsistent:

which should mostly be finding out the right symbol for that indentation level (along with two odd ones at doc/CHANGELOG.rst:83).

@mtreinish
Copy link
Member Author

mtreinish commented Dec 18, 2018

While checking the release notes and changelog, can we take a pass at fixing the Sphinx warnings in those docs? There are a bunch of:

doc/CHANGELOG.rst:540: WARNING: Title underline too short.

which should be just a matter of fixing the number of symbols, and also a number of:

CHANGELOG.rst:23: WARNING: Title level inconsistent:

which should mostly be finding out the right symbol for that indentation level (along with two odd ones at doc/CHANGELOG.rst:83).

All the warning should be fixed now with: 5b4a503 I think after we get the release out we should use https://pypi.org/project/doc8 in ci to verify our docs are formatted well.

@mtreinish mtreinish changed the title [WIP] Update the changelog and add release notes for 0.7 Update the changelog and add release notes for 0.7 Dec 18, 2018
@mtreinish
Copy link
Member Author

I removed the WIP, but before we merge this I think we need people to review this and make sure it's:

  1. Not missing anything important for the release
  2. Make sure everything it's saying is still accurate giving the recent last minute changes
  3. Has no glaring typos or other grammatical issues :)

@@ -1,23 +1,295 @@

###############
Copy link
Member

Choose a reason for hiding this comment

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

@mtreinish i know this is strange my convention but is because when i make the tutorials it has the same heading

Copy link
Member Author

Choose a reason for hiding this comment

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

it was throwing a warning in sphinx because it was getting confused by the levels (see Diego's earlier comment). I just referenced the sphinx documentation: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections to make sure sphinx didn't get confused

@ajavadia ajavadia force-pushed the add-release-documentation-0.7 branch from 640fd8d to 87ecadd Compare December 19, 2018 08:57
@atilag atilag merged commit 0a842e0 into Qiskit:master Dec 19, 2018
@mtreinish mtreinish deleted the add-release-documentation-0.7 branch December 19, 2018 14:22
lia-approves pushed a commit to edasgupta/qiskit-terra that referenced this pull request Jul 30, 2019
* Update the changelog and add release notes for 0.7
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.

Update the release notes and changelog
5 participants