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

Update documentation v0.1.3 #33

Open
Xnsam opened this issue Nov 21, 2024 · 0 comments · May be fixed by #37
Open

Update documentation v0.1.3 #33

Xnsam opened this issue Nov 21, 2024 · 0 comments · May be fixed by #37
Assignees
@ozkanuysal
Labels
documentation Improvements or additions to documentation

Comments

@Xnsam
Copy link
Collaborator

Xnsam commented Nov 21, 2024 •
edited
Loading

  1. Create a docs folder in the repo
  2. Update the docs folder using sphinx-build
  3. Write a github workflow to follow the flow, on push -> create an environment -> check out the latest code -> run sphinx build -> push the code to gesund-ai.github.io branch -> clean up
  4. Perform manual checks for documentation. you can re-use the documentation already created to some extent.
@Xnsam Xnsam changed the title Update documentation Update documentation v0.1.3 Nov 21, 2024
@ozkanuysal ozkanuysal added the documentation Improvements or additions to documentation label Nov 21, 2024
@ozkanuysal ozkanuysal linked a pull request Nov 25, 2024 that will close this issue
docs(documentation): Add GitHub Actions workflow for Sphinx docs deployment #37
Open
@ozkanuysal ozkanuysal removed a link to a pull request Nov 25, 2024
docs(documentation): Add GitHub Actions workflow for Sphinx docs deployment #37
Open
@ozkanuysal ozkanuysal linked a pull request Nov 25, 2024 that will close this issue
docs(documentation): Add GitHub Actions workflow for Sphinx docs deployment #37
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ozkanuysal ozkanuysal

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

Successfully merging a pull request may close this issue.

docs(documentation): Add GitHub Actions workflow for Sphinx docs deployment gesund-ai/gesund
2 participants
@Xnsam @ozkanuysal