Refactor/documentation #199
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
* Move installation instructions to the source folder * Fix local links and urls
* Add namespace tag to the first top-level occurrence of each main namespace * Tidy up README headers so they are more consistent * Remove author tags * Minor typo corrections
* Use toplevel README as main page * Add protocol, python and demo dirs * Do not extract all local classes
domire8
previously approved these changes
Sep 7, 2021
domire8
approved these changes
Sep 7, 2021
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.
Here's a minor documentation overall to make our released documentation more pleasing.
There is now a top-level page, a list of pages in the "related pages" tab, and all namespaces show up properly in the namespace tab.
I pushed the result to the website temporarily:
https://epfl-lasa.github.io/control_libraries/versions/tmp/