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

Add documentation page via Readthedocs #15

Merged
merged 12 commits into from
Jun 26, 2024
Merged

Add documentation page via Readthedocs #15

merged 12 commits into from
Jun 26, 2024

Conversation

KedoKudo
Copy link
Contributor

This PR introduces the following changes:

  • Add developer and user documentations for current state of bm3dornl.
  • Enabled integration with Readthedocs

Testing instructions

  1. Check the documentation page in https://bm3dornl.readthedocs.io/en/add_docs/
  2. Checkout the branch and build the docs locally

EWM item: 4922

@KedoKudo KedoKudo requested a review from jmborr June 25, 2024 14:51
@KedoKudo KedoKudo self-assigned this Jun 25, 2024
dmitry-ganyushin
dmitry-ganyushin approved these changes Jun 26, 2024
View reviewed changes
Copy link
Contributor

@dmitry-ganyushin dmitry-ganyushin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to update documentations once multiscale part is merged.

@KedoKudo KedoKudo merged commit 2ad9625 into next Jun 26, 2024
3 checks passed
@KedoKudo KedoKudo deleted the add_docs branch June 26, 2024 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmitry-ganyushin dmitry-ganyushin dmitry-ganyushin approved these changes

@jmborr jmborr Awaiting requested review from jmborr

Assignees

@KedoKudo KedoKudo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KedoKudo @dmitry-ganyushin