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

dev-0.1.5 #18

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

dev-0.1.5 #18

wants to merge 22 commits into from

Conversation

kdduha
Copy link
Collaborator

@kdduha kdduha commented Oct 27, 2024 •
edited
Loading

  • Refactor function docstrings
  • Refactor/update framework examples
  • Update framework documentation
  • Implement new docs with pdoc backend
  • Add build and deploy jobs of docs in github workflow
  • Move torchcnnbuilder.preprocess.time_series to torchcnnbuilder.preprocess

Doc example (deployed from personal forked repo):

@kdduha kdduha self-assigned this Oct 27, 2024
@kdduha kdduha added documentation Improvements or additions to documentation refactoring Refactoring code labels Oct 27, 2024
@kdduha
Copy link
Collaborator Author

kdduha commented Oct 28, 2024 •
edited
Loading

TBD:

  • change doc backend to pdoc

@kdduha
Copy link
Collaborator Author

kdduha commented Oct 30, 2024 •
edited
Loading

TBD:

  • refactor lint in order to ignore docstrings
  • add job in github workflow with doc auto building
  • serve doc in github pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@kdduha kdduha

Labels
documentation Improvements or additions to documentation refactoring Refactoring code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kdduha