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

Renew Documentation #62

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Renew Documentation #62

wants to merge 1 commit into from

Conversation

shaharbar1
Copy link
Collaborator

Changes

  • Removed all rst files, and replaced with matching md files.
  • Add md extension on conf.py.
  • Edited api and fullapi files with relevant content.
  • Added Shahar Bar to authors.
  • Edited tutorial jupyter notebooks.
  • Updated README.md content.
  • Removed make.bat due to redundancy.
  • Edited makefile to clean before build.
  • Added PyPi classifiers on pyproject.toml.

@shaharbar1 shaharbar1 added the documentation Improvements or additions to documentation label Sep 25, 2024
@shaharbar1 shaharbar1 linked an issue Sep 25, 2024 that may be closed by this pull request
Update README.md to reflect current state of the code #30
Open
@shaharbar1 shaharbar1 force-pushed the feature/renew_docs branch 4 times, most recently from 7ee2dbf to 9ddc931 Compare September 29, 2024 09:57
@Shahar-Bar
Renew Documentation
c62a29d 
 ### Changes
 * Removed all rst files, and replaced with matching md files.
 * Add md extension on conf.py.
 * Edited api and fullapi files with relevant content.
 * Added Shahar Bar to authors.
 * Edited tutorial jupyter notebooks.
 * Updated README.md content.
 * Removed make.bat due to redundancy.
 * Edited makefile to clean before build.
 * Added PyPi classifiers on pyproject.toml.
 * Moved html outputs of make under docs/build/html.
 * Added acronyms.md.
 * Added continuous_documentation.yml to continuously update documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adarmiento adarmiento Awaiting requested review from adarmiento

@dariodandrea dariodandrea Awaiting requested review from dariodandrea

@j3rom3c j3rom3c Awaiting requested review from j3rom3c

At least 1 approving review is required to merge this pull request.

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

Successfully merging this pull request may close these issues.

Update README.md to reflect current state of the code
2 participants
@shaharbar1 @Shahar-Bar