diff --git a/doc/conf.py b/doc/conf.py index d4503b43..8ea9f2f8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -222,7 +222,7 @@ def setup(app): ("Examples", "auto_examples/index"), ("User guide", "user_guide/index"), ("FAQ", "faq"), - ("GitHub", "https://github.com/neurotechx/eeg-notebooks", True), + ("GitHub", "https://github.com/neurotechx/eeg-expy", True), ], # Set the page width to not be restricted to hardset value @@ -261,8 +261,8 @@ def setup(app): 'within_subsection_order': FileNameSortKey, 'default_thumb_file': 'img/eeg-notebooks_logo.png', 'backreferences_dir': 'generated', # Where to drop linking files between examples & API - 'doc_module': ('eeg-notebooks'), - 'reference_url': {'eeg-notebooks': None}, + 'doc_module': ('eeg-expy'), + 'reference_url': {'eeg-expy': None}, 'remove_config_comments': True} """ @@ -282,8 +282,8 @@ def setup(app): 'within_subsection_order': FileNameSortKey, 'default_thumb_file': 'img/eeg-notebooks_logo.png', 'backreferences_dir': 'generated', # Where to drop linking files between examples & API - 'doc_module': ('eeg-notebooks',), - 'reference_url': {'eeg-notebooksS': None}, + 'doc_module': ('eeg-expy',), + 'reference_url': {'eeg-expy': None}, 'remove_config_comments': True, } diff --git a/doc/misc/about_the_docs.md b/doc/misc/about_the_docs.md index 5eb36937..c06e386a 100644 --- a/doc/misc/about_the_docs.md +++ b/doc/misc/about_the_docs.md @@ -1,11 +1,12 @@ -# About the EEG-notebooks Documentation Pages +# About the EEG-ExPy Documentation Pages A few comments on how these are put together: The documentation pages are written for the following readthedocs sphinx-based setup: - `readthedocs` auto-generates the documentation, using various configuration files -- In particular, we use [Nbsphinx](https://github.com/spatialaudio/nbsphinx) to create `html` pages directly from a combination of jupyter notebooks, `.rst` files, and `.md` files -- Because the notebook files are not located under the docs folder, we additionally need to make use of [nbsphinx-link](https://github.com/vidartf/nbsphinx-link) +- In particular, we use [Nbsphinx](https://github.com/spatialaudio/nbsphinx) to create `html` pages directly. + from a combination of jupyter notebooks, `.rst` files, and `.md` files +- Because the files are not located under the docs folder, we additionally need to make use of [nbsphinx-link](https://github.com/vidartf/nbsphinx-link)