Skip to content
This repository was archived by the owner on Jan 13, 2023. It is now read-only.

Improve API documentation #261

Merged
merged 1 commit into from
Nov 14, 2019
Merged

Improve API documentation #261

merged 1 commit into from
Nov 14, 2019

Conversation

lzpap
Copy link
Collaborator

@lzpap lzpap commented Nov 12, 2019 •
edited by todofixthis
Loading

Solves #260

Changes

  • Restructured API documentation into 3 parts:

    • API classes
    • Core API commands
    • Extended API commands

  • Improve docstrings of API calls and types.

  • Introduce autodoc support for sphinx to generate
    documentation from docstrings.

  • Update Discord channel information

View changes in browser

cd iota.py
pip install .[docs-builder]
cd docs
make html

Then you can open docs/_build/html/index.html to view the documentation.

@lzpap lzpap self-assigned this Nov 12, 2019
todofixthis
todofixthis approved these changes Nov 12, 2019
View reviewed changes
Copy link
Contributor

@todofixthis todofixthis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very thorough! Looks great!! A few questions/suggestions, but overall LGTM 😺

@lzpap lzpap mentioned this pull request Nov 13, 2019
Closed
@lzpap
Improve API documentation
dba8acf 
- Restructured API documentation into 3 parts:
  - API classes
  - Core API commands
  - Extended API commands

- Improve docstrings of API calls and types.
- Introduce autodoc support for shpinx to generate
  documentation from docstrings.
- Add autosectionlabel extension to sphinx.
lzpap
lzpap commented Nov 13, 2019
View reviewed changes
todofixthis
todofixthis approved these changes Nov 13, 2019
View reviewed changes
Copy link
Contributor

@todofixthis todofixthis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lzpap lzpap merged commit e033dc8 into iotaledger-archive:develop Nov 14, 2019
@lzpap lzpap mentioned this pull request Nov 14, 2019
Merged
@lzpap lzpap mentioned this pull request Nov 26, 2019
Merged
@lzpap lzpap mentioned this pull request Jan 9, 2020
Closed
@lzpap lzpap deleted the api_docs_rethink branch January 28, 2020 10:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@todofixthis todofixthis todofixthis approved these changes

Assignees

@lzpap lzpap

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lzpap @todofixthis