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

Documentation: Describe API as it require for python package documentation #10

Open
vsysoev opened this issue Dec 27, 2022 · 8 comments
Open

Documentation: Describe API as it require for python package documentation #10

vsysoev opened this issue Dec 27, 2022 · 8 comments
Assignees
@vsysoev
Labels
documentation Improvements or additions to documentation
Milestone
MVP

Comments

@vsysoev
Copy link
Contributor

vsysoev commented Dec 27, 2022 •
edited
Loading

Write down current API state.

Need to understand how to prepare python styled documentation for python modules.
@vsysoev vsysoev added this to the MVP milestone Dec 27, 2022
@vsysoev vsysoev added the documentation Improvements or additions to documentation label Dec 27, 2022
@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 27, 2022

how to make doc:
https://packaging.python.org/en/latest/tutorials/creating-documentation/

@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 27, 2022

integration with GitHub https://docs.readthedocs.io/en/latest/integrations.html

@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 27, 2022

template for readthedocs https://github.com/readthedocs/tutorial-template

@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 27, 2022

readthedoc need admin access to be able to install web hooks. I am not sure that we have to grant it.

@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 28, 2022

I've decided to open source this repo now. Looks like it is good for development process and usage of reathedocs as documentation for API.

@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 28, 2022

Looks like build of docs was successful. Now we can do documentation in doc-as-a-code style
https://pygats.readthedocs.io/en/latest/

@vsysoev vsysoev self-assigned this Dec 28, 2022
@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 28, 2022

Internationalisation is required.

vsysoev pushed a commit that referenced this issue Dec 28, 2022
#10: Start documentation implementation
429e365
vsysoev pushed a commit that referenced this issue Dec 28, 2022
#10: fix sphinx build error. Moved README.rst to docs/sources/index.rst.
6a77546
vsysoev pushed a commit that referenced this issue Dec 28, 2022
#10: Fixed $project with pyGATs.
d5fa168
@vsysoev
Copy link
Contributor Author

vsysoev commented Dec 28, 2022

Sample of documentation added https://pygats.readthedocs.io/en/latest/

vsysoev pushed a commit that referenced this issue Dec 28, 2022
#10: Added build documentation instruction in README
17f4d61
vsysoev pushed a commit that referenced this issue Dec 28, 2022
#10: Fixed URL in index.rst
4c8187c
vsysoev added a commit that referenced this issue Dec 28, 2022
@vsysoev
enabled documentation for the project
c08a89e 
* #10: Start documentation implementation

* #10: fix sphinx build error. Moved README.rst to docs/sources/index.rst.

* #10: Fixed $project with pyGATs.

* #10: Added build documentation instruction in README

* #10: Fixed URL in index.rst

* #12: Enable pylint for module

* Create build and test python package

* #12: added badges to readme

* #12: replace installed module with local module

* #12: fixed issue with python -m pytest

* Rename src/pyGATs/pygats.py to src/pygats/pygats.py

* Rename src/pyGATs/__init__.py to src/pygats/__init__.py

Co-authored-by: Sysoev, Vladimir <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vsysoev vsysoev

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
MVP
Development

No branches or pull requests
1 participant
@vsysoev