675 documentation #714
Merged
675 documentation #714
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| from ._common import * | ||
| from ._numpy import * |
Check notice
Code scanning / CodeQL
'import *' may pollute namespace Note
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #714 +/- ##
=======================================
Coverage 86.67% 86.68%
=======================================
Files 399 399
Lines 50718 50718
=======================================
+ Hits 43960 43964 +4
+ Misses 6758 6754 -4 ☔ View full report in Codecov by Sentry. |
|
I think I'll merge this, it isn't done, but it is a start! :) |
Signed-off-by: Nick Papior <[email protected]>
also cleaned up some details when adding more documentation for the basic things. added more to the first tutorial which are now in an nbgallery restructure of the docs Signed-off-by: Nick Papior <[email protected]>
changed header for publications fixed lists and definition lists created better alignment for noise_power Signed-off-by: Nick Papior <[email protected]>
zerothi
force-pushed
the
675-documentation
branch
from
164b65b to
a6667eb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
First attempt at doing something for the documentation.
This is far from complete, but some feedback on how it looks might be valuable.
It seems notebooks are just simpler to use, and perhaps we should just stick with that :)
You can see the page here:
https://www.student.dtu.dk/~nicpa/sisl/html/rtd/index.html
I would like to hide a bit more in the menu to the left, or at least move up the guides/tutorials etc.
Easy to do things.
isort .andblack .[24.2.0] at top-leveldocs/CHANGELOG.md