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

Reorganize root directory #646

Draft
wants to merge 32 commits into
base: master
Choose a base branch
from
Draft

Reorganize root directory #646

wants to merge 32 commits into from

Conversation

ehennestad
Copy link
Collaborator

Motivation

Simplify the root folder and group files logically.

How to test the behavior?

N/A

Todo

  • Update relative paths in workflows
  • Add installation notes: addpath(path/to/matnwb/code)
  • Update relative links in documentation
  • Verify misc.getMatNwbDir works a expected wherever it is used
  • Verify that root directory is always resolved using misc.getMatNwbDir
  • Check that documentation builds as expected
  • Check that tests run as expected

Checklist

  • Have you ensured the PR description clearly describes the problem and solutions?
  • Have you checked to ensure that there aren't other open or previously closed Pull Requests for the same change?
  • If this PR fixes an issue, is the first line of the PR description fix #XX where XX is the issue number?

ehennestad and others added 30 commits December 6, 2024 12:32
@ehennestad
Update main function docstrings to work better with sphinx/rst format…
09d464c 
…ting

Add "sections"
Specify input and output arguments
Reformat examples
@ehennestad
Add tools for creating rst pages for functions, classes and tutorials
37187b6
@ehennestad
Add docs source
a231307
@ehennestad
Add .readthedocs.yaml
a34b243
@ehennestad
Delete previous doc files
48ba248
@ehennestad
Update export location for tutorial html files
8dddf6e
@ehennestad
remove html files from tutorials/html
f989984 
(files are now located in docs/source/_static/html/tutorials)
@ehennestad
Fix indentation in function docstrings
8aa83c3
@ehennestad
Add proper titles and "open in MATLAB Online" badges to tutorial pages
d913c6b
@ehennestad
Update main page and add installation instructions
3cb5a33
@ehennestad
Add view full page badge for tutorials
ace3a4c
@ehennestad
Add hdmf_common types plus smaller changes
4e65fce 
Fix: Make sure neurodata types specfied with "short names" in the documentation for properties of generated classes are properly linked to their corresponding class pages in the docs i.e (TimeSeries)
Add links to the nwb format specification for each type
@ehennestad
Delete docstring_processors.cpython-311.pyc
ab1f8cd
@ehennestad
Update neurdata class rst template
7bb419d
@ehennestad
Update docstring_processors.py
4c891e8 
- Add docstring processors for adding role to class properties and change formatting for sphinx-autodetected class constructor from reference to constructor method to reference for class
@ehennestad
Update generator to add more information in class docstrings
a61884e
@ehennestad
Rerun generateCore (update all classes)
5c5400f
@ehennestad
Update link target attributes in livescript htmls
78c1f8d
@ehennestad
Fix previous commit - use correct target attribute value
9afb81c
@ehennestad
Update links for types to point to readthedocs
11d96fc
@ehennestad
Update livescript html files
a87f1b5
@ehennestad
Add favicon, dynamic iframe height, youtube badge for tutorial
6177e3b
@ehennestad
Update .codespellrc
7521754
@ehennestad
Fix links in tutorials, add hdmf_experimental types
097114a
@ehennestad
Fix wrong/outdated links in livescript tutorials tutorials
0672555
@bendichter
Update tutorial_config.json
a035578
@ehennestad
Merge branch 'update-documentation-to-sphinx' of https://github.com/N…
b42f7c7 
…eurodataWithoutBorders/matnwb into update-documentation-to-sphinx
@ehennestad
Update pages
020f752 
add section from matnwb readme
add pages from nwb-overview
minor rearrangement
@ehennestad
Minor fixes
70da055
@ehennestad
Merge branch 'master' into update-documentation-to-sphinx
1771f58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ehennestad @bendichter