Skip to content

Commit

Permalink
update for more misc files
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnGriffiths committed Dec 5, 2023
1 parent d5574d3 commit 9d68317
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions doc/docs_notes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EEG-Notebooks Documentation Developer Notes
# EEG-ExPy Documentation Developer Notes

The documentation page can be found at https://neurotechx.github.io/eeg-notebooks
The documentation page can be found at https://neurotechx.github.io/eeg-expy

The documentation source files are a combination of plain-text `.rst`, `.md`, and `.py` files.

Expand All @@ -9,8 +9,8 @@ It is built locally with `sphinx`, and hosted on the github repo `gh-pages` bran

There are two main locations for the documentation files:

- The various files and sub-folders in `eeg-notebooks/doc`, which contain the webpage contents
- The files and sub-folders in `eeg-notebooks/examples`, which contains `.py` scripts, grouped by experiment
- The various files and sub-folders in `eeg-expy/doc`, which contain the webpage contents
- The files and sub-folders in `eeg-expy/examples`, which contains `.py` scripts, grouped by experiment

This general organization (with `doc` and `examples` folders) is widely used by excellent python libraries such as `MNE` and `Nilearn`, and we are largely following suit in the organization here.

Expand All @@ -35,7 +35,7 @@ In terminal 1: edit the source files

In terminal 2: build and re-build the docs periodically to inspect changes

`cd eeg-notebooks/doc`
`cd eeg-expy/doc`
`make html`

In terminal 3: keep a local http server running to render the docs
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
getting_started/running_experiments
getting_started/data_zipper
getting_started/analysis
getting_started/available_notebooks
getting_started/available_experiments

.. toctree::
:caption: Experiments
Expand Down

0 comments on commit 9d68317

Please sign in to comment.