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.

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

Next Steps Tutorial #710

Merged
merged 12 commits into from
Apr 9, 2024
Merged

Next Steps Tutorial #710

merged 12 commits into from
Apr 9, 2024

Conversation

garrettmflynn
Copy link
Member

This PR implements the Next Steps section of the tutorials.

@garrettmflynn garrettmflynn self-assigned this Mar 28, 2024
Base automatically changed from multisession-tutorial to main April 3, 2024 19:46
@CodyCBakerPhD
Copy link
Collaborator

@garrettmflynn Looks like doc build is failing here

@garrettmflynn
Copy link
Member Author

Hmm I'd found a few header mismatches. But I'm not sure what the persistent issue is coming from...

@CodyCBakerPhD
Copy link
Collaborator

Hmm I'd found a few header mismatches. But I'm not sure what the persistent issue is coming from...

Is it able to build successfully locally?

@garrettmflynn
Copy link
Member Author

Yes though I'm using sphinx-build -b html docs/ _build/html/ and commenting out from conf_extlinks import extlinks, intersphinx_mapping in conf.py.

This method doesn't seem to care about things that RTD does—so I'm assuming this isn't really the correct way to test locally.

Can you confirm?

@CodyCBakerPhD
Copy link
Collaborator

and commenting out from conf_extlinks import extlinks, intersphinx_mapping in conf.py.

You shouldn't have to comment out anything

@garrettmflynn
Copy link
Member Author

I have not been able to get around the following error:

  File "/Users/garrettflynn/Documents/GitHub/nwb-guide/docs/conf.py", line 5, in <module>
    from conf_extlinks import extlinks, intersphinx_mapping
ModuleNotFoundError: No module named 'conf_extlinks'

Any suggestions would be appreciated. I seem to be following all available similar documentation appropriately.

@CodyCBakerPhD
Copy link
Collaborator

Is your pwd inside the docs? Or +/- directory above/below somewhere

@garrettmflynn
Copy link
Member Author

I'm running the command from the base of the repository. Running from docs didn't change anything.

Is that the same as the pwd?

@CodyCBakerPhD
Copy link
Collaborator

@garrettmflynn
Copy link
Member Author

Yep no luck. Always the same resolution error for conf_extlinks

docs/conf_extlinks.py Outdated Show resolved Hide resolved
@CodyCBakerPhD CodyCBakerPhD marked this pull request as ready for review April 6, 2024 18:46
docs/conf_extlinks.py Outdated Show resolved Hide resolved
@CodyCBakerPhD CodyCBakerPhD enabled auto-merge April 9, 2024 02:38
@CodyCBakerPhD CodyCBakerPhD merged commit 871997b into main Apr 9, 2024
14 checks passed
@CodyCBakerPhD CodyCBakerPhD deleted the nextsteps-tutorial branch April 9, 2024 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants