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

feat(docs): docs generation #76

Closed
wants to merge 1 commit into from
Closed

feat(docs): docs generation #76

wants to merge 1 commit into from

Conversation

lilpuzeen
Copy link
Collaborator

@lilpuzeen lilpuzeen commented Dec 16, 2023 •
edited by k4black
Loading

Description

  • Add new markdown pages into the docs generation
  • Use 'mike' for docs build and deployment
  • Add dependencies list into the 'pyproject.toml'
  • Implement docs-build and docs-serve commands in 'Makefile'

Motivation and Context

Closes #74

Contribution Checklist

  • I have read and agreed on the CONTRIBUTING and CODE OF CONDUCT documents.
  • I have run linters, type checks, import sorting and tests locally.
  • I have added comments to code in hard-to-understand areas.
  • I have added 100% coverage tests for the new code (or aren't needed).
  • I have added docs for the new code (or aren't needed).
  • I have used conventional commits title: tag(scope): description.

[optional] Screenshots

[optional] Special notes

[optional] What gif best describes this PR or how it makes you feel?

@lilpuzeen
feat(docs): docs generation refactor
87a29ce 
- Add new markdown pages into the docs generation
- Use 'mike' for docs build and deployment
- Add dependencies list into the 'pyproject.toml'
- Implement docs-build and docs-serve commands in 'Makefile'
@github-actions github-actions bot added documentation Improvements or additions to documentation feature refactor labels Dec 16, 2023
@k4black k4black changed the title feat(docs): docs generation refactor feat(docs): docs generation Dec 16, 2023
@lilpuzeen lilpuzeen closed this by deleting the head repository Dec 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation feature refactor
Projects
None yet
Milestone
No milestone
Development

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