Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Module documentation with pdoc #2

Closed
Tim55667757 opened this issue Jul 1, 2022 · 1 comment
Closed

Module documentation with pdoc #2

Tim55667757 opened this issue Jul 1, 2022 · 1 comment
Assignees
@Tim55667757
Labels
Documentation Improvements or additions to documentation
Milestone
release-1.1

Comments

@Tim55667757
Copy link
Owner

No description provided.

@Tim55667757 Tim55667757 added the Documentation Improvements or additions to documentation label Jul 1, 2022
@Tim55667757 Tim55667757 self-assigned this Jul 1, 2022
@Tim55667757 Tim55667757 added this to the release-1.1 milestone Jul 11, 2022
Tim55667757 added a commit that referenced this issue Jul 14, 2022
@Tim55667757
#2 Prepare TKSBrokerAPI module to build with pdoc-engine
af2aee0
Tim55667757 added a commit that referenced this issue Jul 14, 2022
@Tim55667757
#2 debug version of pdoc builder: https://pdoc.dev/docs/pdoc.html#pdoc
1b7924f
Tim55667757 added a commit that referenced this issue Jul 14, 2022
@Tim55667757
#2 debug version of documentation by pdoc
36e10db
Tim55667757 added a commit that referenced this issue Jul 14, 2022
@Tim55667757
#2 add pdoc link to english readme
372921b
Tim55667757 added a commit that referenced this issue Jul 14, 2022
@Tim55667757
#2 add pdoc link to russian readme
fc8c039
Tim55667757 added a commit that referenced this issue Jul 14, 2022
@Tim55667757
Merge pull request #23 from Tim55667757/develop
2ecc7f6 
Testing for issue #2 debug docs with pdoc
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
#2 a) preparing for pdoc documentation, b) static method `GetDatesAsS…
3ecd7ae 
…tring()` moved outside from class `TinkoffBrokerServer()`, c) `instrumentsList` variable renamed as `iList`.
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
#2 preparing TKSEnums module for pdoc documentation
ad82bed
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
#2 little typo
6fcad57
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
#2 Created module documentation with pdoc
28317e0
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
#2 task done, changelog updated
8d3276c
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
Merge pull request #24 from Tim55667757/develop
7bc1908 
Task #2 done: module documentation with pdoc
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
#2 TKSBrokerAPI module documentation saved
7a90cef
Tim55667757 added a commit that referenced this issue Jul 15, 2022
@Tim55667757
Merge pull request #25 from Tim55667757/develop
5b30f41 
Task #2 `TKSBrokerAPI` module documentation saved
@Tim55667757
Copy link
Owner Author

Minimal documentation on module TKSBrokerAPI was generated with pdoc engine. It is available here: https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSBrokerAPI.html

Tim55667757 added a commit that referenced this issue Jul 20, 2022
@Tim55667757
#2 improved readability of setup.py
08d4a0c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Tim55667757 Tim55667757

Labels
Documentation Improvements or additions to documentation
Projects
None yet
Milestone
release-1.1
Development

No branches or pull requests
1 participant
@Tim55667757