First draft of proposal for documentation rewrite #1178
Merged
Conversation
This file contains hidden or 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
[skip ci]
Note that for the purposes of getting sphinx to run both locally and on readthedocs, we duplicate example data in two locations. A proper solution to this (probably downloading from Gin) is needed
|
Yeah. You are our hero. |
|
Hi @apdavison Thanks for getting this started. I added some more changes on top of yours in #1179 and am still adding to this. If you prefer to only have a single dev branch for the new doc you can also already merge #1179. |
|
Some suggestions for what parts of the (developer) documentation needs improvement can also be found here |
Further documentation improvements
* master: (138 commits) fix for #1227 spikeglx naming debug #1240 [CI] Generate conda env directly with required packages Update doc/source/rawio.rst Update doc/source/io_developers_guide.rst Update io_developers_guide.rst Update developers_guide.rst Update io_developers_guide.rst Update rawio.rst Update io_developers_guide.rst Update io.rst Update core.rst Exception -> ValueError fix: check 'states' length before inferring event durations Add ignore_timestamps_errors flag improved 1.0-NHP probe docs added imDatPrb_type=1031 support as per SpikeGLX source added NP 1.0-NHP short and medium length support spikeglxrawio.py updated to support 45mm 1.0-NHP probes use OS independent datetime formatting ... # Conflicts: # doc/requirements_docs.txt # doc/source/rawio.rst
|
I've switched to pydata_sphinx_theme, which I think looks much nicer. While there are still things to be improved, I think we should merge this now, if you're happy with it, and create a separate issue for each of the desired improvements. |
Remove reference to all_data property in docstring of class Segment
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
See https://neo.readthedocs.io/en/new-docs/
Main features:
Todos: