Initial documentation using MkDocs #123
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
eallen288
reviewed
Mar 29, 2022
|
ejfitzgerald
approved these changes
Mar 29, 2022
5A11
added a commit
that referenced
this pull request
Mar 30, 2022
* Aerial High Level API (#96) * Aerial: Initial offline table based gas strategy (#107) * gov module queries support (#91) * gov api * docstrings improved darglint check added to CI workflow * Aerial: Simulation based Gas estimation (#108) * added darglint support for flake8 (#109) * unused darglint config removed from the setup.cfg (#111) * unused darglint config removed from the setup.cfg * darglint dedicated checks removed * change remove pipfile.lock and test workflow * revert intentional error Co-authored-by: ali <[email protected]> * chores: update protos to cosmos v0.42.11, fix Makefile (#113) * fix: recursive make commands invocations recursive make commands should always use the variable MAKE https://www.gnu.org/software/make/manual/html_node/MAKE-Variable.html#MAKE-Variable * fix: lock python version lock python version for `new_env` and `new_env_dev` Makefile targets * chores: bump cosmos-sdk base version * chores: regenerate proto files * chores: gitignore proto generation workdirs * add slashing module API (#116) * added evidence module API (#117) * fix: staking test_Validators assert (#119) * feat: add params rest client (#120) * feat: add params rest client, fix simulate call * chores: lint * Add distribution module (#92) * Add distribution module * Create distribution rest client * Add tests for distribution module * Remove unused import * run black and isort Signed-off-by: David Pierret <[email protected]> * Update regexp to accept external modifications Signed-off-by: David Pierret <[email protected]> * remove not needed parameter Signed-off-by: David Pierret <[email protected]> * add slashes content in tests Signed-off-by: David Pierret <[email protected]> * Add a test on parameter values Check the values are correctly encoded/decoded by the protobuf code. Signed-off-by: David Pierret <[email protected]> * chores: fix docstrings Co-authored-by: David Pierret <[email protected]> Co-authored-by: Flavien Binet <[email protected]> * Mint module (#122) * Add Mint module * Create MintRestClient * Create Mint tests * fix after check Signed-off-by: David Pierret <[email protected]> * Managment of the wrong value encoding Some endpoints reply with strings when base64 encoded values are expected. The tests check that all the values are correct Signed-off-by: David Pierret <[email protected]> * fix lint issues Signed-off-by: David Pierret <[email protected]> * chores: fix docstrings * chores: fix more docstrings * pylint/mypy/linting fixes Co-authored-by: David Pierret <[email protected]> Co-authored-by: Flavien Binet <[email protected]> Co-authored-by: Galadrin <[email protected]> * Initial documentation using MkDocs (#123) * mkdocs setup and first few pages * revert makefile dev python to 3.9; minor docs edit * bump black version to 22.3 * delete extra files * add deploy contract docs page * Basic staking support (#125) * feat: staking support for aerial * docs: initial staking doc * staking minor edits * Update cosmpy/aerial/client/__init__.py Co-authored-by: daeMOn <[email protected]> * chore: review comments * chore: appeasing the style police Co-authored-by: ali <[email protected]> Co-authored-by: daeMOn <[email protected]> * Minor docs edit (#129) * minor edits * cosmos sdk remove hyphen * Feature/release 0.3.0 (#131) * bump version in setup.py * update history.md Co-authored-by: Ed FitzGerald <[email protected]> Co-authored-by: Yuri Turchenkov <[email protected]> Co-authored-by: daeMOn <[email protected]> Co-authored-by: Galadrin <[email protected]> Co-authored-by: David Pierret <[email protected]>
This was referenced Apr 19, 2022
Closed
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 sets MkDocs documentation system up (replacing the existing non-developed sphinx system) and adds a few documentation pages.