This repository has been archived by the owner on Jun 14, 2024. It is now read-only.
Update Docstrings & Create Jupyter_book Directory in docs #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 17 commits
November 13, 2023 12:59
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
* Update README.md Add SSEC badge * Move project to src/ directory * Update Codespaces link * Update README.md * Update README.md Update Codespaces link * Update devcontainer * ci: Create cd.yml for building and pushing package * Update caustic name to caustics * Add PyLint and Black formatting features to devcon * Closes issue uw-ssec#16 * Updated test/ -> tests/ * Move project to src/ directory * Update README.md * Update README.md Update Codespaces link * Create noxfile.py * Add .readthedocs.yaml * Create .git_archival.txt * Create .gitattributes * Create .pre-commit-config.yaml * Add sphinx and myst-parser support * style: pre-commit fixes * Update docs * style: pre-commit fixes * Update .github Actions * Update environment.yml - Add jupyter-book * Create CONTRIBUTING.md * Update README.md * chore: resolve conflicts * chore: Remove sources * test: remove test lenses * test: fix test_simulator * chore: Set min python to 3.9 * fix: change pytest to point to tests/ * build: update dep list to use reqs.txt * ci: Don't fail fast * chore(deps): Pin astropy < 6 * fix: change instances of caustic to caustics * fix: Perform pre-commit * fix: update path to conf.py * update README * style: pre-commit fixes * docs: Add contributor graph * chore: Setup dynamic versioning * ci: Update fetch depth to 0 to get correct version * Update README.md Update Codespaces button to new repo name --------- Co-authored-by: Cordero Core <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* ci: update yaml configuration for CI * style: pre-commit fixes --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
added 11 commits
November 27, 2023 15:54
lsetiawan
force-pushed
the
sophie-test
branch
from
c2a1f35
to
6c9f90b
Compare
…into sophie-test
lsetiawan
reviewed
Nov 29, 2023
lsetiawan
added a commit
that referenced
this pull request
Dec 6, 2023
This is a duplicated work from PR #25. This improved the documentation to use Jupyter Book instead of vanilla sphinx. Google docstring style has been updated to Numpy docstring style. --- Ref: #11 Original author: https://github.com/sophietao127
|
Changes integrated in Ciela-Institute#110 |
ConnorStoneAstro
pushed a commit
to Ciela-Institute/caustics
that referenced
this pull request
Dec 8, 2023
This is a PR from uw-ssec#25. This improved the documentation to use Jupyter Book instead of vanilla sphinx. Google docstring style has been updated to Numpy docstring style. --- Ref: uw-ssec#11 Original author: https://github.com/sophietao127 - docs: Add tutorials - Added index.md to tutorials - Updated _config.yml and _toc.yml - docs: Lint docs and update notebooks --------- Co-authored-by: Landung 'Don' Setiawan <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issues
#11
#12
#13
#19
#21
#14