vtr-verilog-to-routing
vtr-verilog-to-routing copied to clipboard
verilog-to-routing
doc: copy changelog to avoid warnings
Sphinx produces multiple warnings because https://github.com/verilog-to-routing/vtr-verilog-to-routing/blob/master/doc/src/CHANGELOG.md does not have a title. In this PR, the file is copied to doc/src in the conf.py, instead of having a "redirection" file.
I don't think I have an informed opinion about whether or not this is the right fix. @acomodi : should we merge this, or would you recommend something else?
I see that CHANGELOG.md in doc/src is actually a symlink to the actual CHANGELOG.md in the root dir, while for the other .md files (e.g. CONTRIBUTING.md), there is no symlink but rather it defines a reference to the actual CONTRIBUTING.md file:
```{include} ../../CONTRIBUTING.md
```
We may try using the same approach for the CHANGELOG.md file and see if this solves the issue.
