Skip to content

Commit 32d6bc0

Browse files
committed
doc: Include changelog in documentation build
Also update changelog formatting to be more documentation friendly.
1 parent dec7667 commit 32d6bc0

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Verilog to Routing (VTR) Change Log
1+
# VTR Change Log
22
<!--
33
This file documents user-facing changes between releases of the VTR
44
project. The goal is to concicely communicate to end users what is new
@@ -32,6 +32,9 @@ candidate release (e.g. v7.0.0). That is, it should be the concatenation
3232
of the unreleased and any previous release candidates change logs.
3333
-->
3434

35+
_Note that changes from release candidates (e.g. v8.0.0-rc1, v8.0.0-rc2) are included/repeated in the final release (e.g. v8.0.0) change log._
36+
37+
<!--
3538
## Unreleased
3639
_The following are changes which have been implemented in the VTR master branch but have not yet been included in an official release._
3740
@@ -44,8 +47,9 @@ _The following are changes which have been implemented in the VTR master branch
4447
### Deprecated
4548
4649
### Removed
50+
-->
4751

48-
## v8.0.0 - 2020-03-16
52+
## v8.0.0 - 2020-03-24
4953

5054
### Added
5155
* Support for arbitrary FPGA device grids/floorplans

doc/src/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../CHANGELOG.md

doc/src/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ For more specific documentation about VPR see :ref:`vpr`.
2929
:caption: Development
3030

3131
dev/index
32+
CHANGELOG
3233

3334
.. toctree::
3435
:maxdepth: 2

0 commit comments

Comments
 (0)