Docs #78
Merged
Docs #78
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
schandrika
reviewed
Oct 2, 2023
README.md
Outdated
| @@ -66,7 +77,7 @@ configuration shown above). This will create a file called web-users.json in the | |||
|
|
|||
| Additionally, the web service provides a RESTful API which can be used by other applications. Full documentation for | |||
| the API is available on | |||
| [Readthedocs](https://volttron.readthedocs.io/en/main/platform-features/web-api/introduction.html). | |||
| [Readthedocs](https://volttron.readthedocs.io/en/modular/external-docs/volttron-lib-web/docs/source/index.html). | |||
There was a problem hiding this comment.
point to eclipse-volttron.readthedocs.io
schandrika
reviewed
Oct 2, 2023
| @@ -19,7 +19,7 @@ packages = [ {include="volttron", from = "src" } ] | |||
| jinja2-cli = ">=0.7.0" | |||
| passlib = "^1.7.4" | |||
| PyJWT = "==1.7.1" | |||
| python = ">=3.8,<4.0" | |||
| python = ">=3.10,<4.0" | |||
| treelib = ">=1.6.1" | |||
| volttron = ">=10.0.2rc0,<11.0" | |||
|
|
|||
There was a problem hiding this comment.
Include sphinx and sphinx-rtd theme in pyproject.toml to build docs locally
schandrika
reviewed
Oct 2, 2023
| "name": "<wheel_name>", | ||
| "uuid": "<uuid>", | ||
| "tag": "<tag>", | ||
| "priority": "<int>", |
There was a problem hiding this comment.
The below code block doesn't display right on html . the symbols < > and | show up in red. please escape
schandrika
reviewed
Oct 2, 2023
| .. code-block:: json | ||
|
|
||
| { | ||
| "status": true|false |
There was a problem hiding this comment.
The value of "status" doesn't display right in the generated html. Please see if the | symbol can be escape for rst to be happy
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.
Updates to documentation.