You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,9 @@ If you are considering larger changes its best to discuss them first (e.g. file
41
41
42
42
Once you've made your enhancements [open a pull request](#making-pull-requests) to get your changes considered for inclusion in the documentation.
43
43
44
+
### How do I build the documentation?
45
+
The documentation can be built by using the command `make html` in the `$VTR_ROOT/doc` directory and you can view it in a web browser by loading the file at `$VTR_ROOT/_build/html/index.html`. More information on building
46
+
the documentation can be found on the [README on GitHub](https://github.com/verilog-to-routing/vtr-verilog-to-routing/tree/master/doc).
44
47
45
48
### Filling Bug Reports
46
49
First, search for [existing issues](https://github.com/verilog-to-routing/vtr-verilog-to-routing/issues?&=) to see if the bug has already been reported.
0 commit comments