Changes for building documentation #319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
guykatzz
approved these changes
Jul 7, 2020
wu-haoze
approved these changes
Jul 7, 2020
matanost
pushed a commit
that referenced
this pull request
Nov 2, 2021
* Doc files * Update headings for readme
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pr contains some changes to the examples file to allow documentation to be built from these files. In addition, a docs folder is added, which contains the sources files to build documentation html files. Readme instructions were added to both docs/ and examples/ to explain how to build documentation and how to format example files. A future pr will setup travis to build the documentation with every master build and push the resulting html files to a website.
In addition, the examples/networks folder was deleted. The example networks have already been reorganized to be located in the root directory's resources folder, so it's redundant to have a separate directory of example network files.