Skip to content

Commit

Permalink
Update24 (#33)
Browse files Browse the repository at this point in the history
* update instructions unit1

* remove code

* remove code

* remove data dir

* updated slides

* remove outdated prep script

* explicitly create conda env in unit 1

* unit2 update

* update unit3

* unit 4

* unit 5

* unit6

* unit6

* update sphinx commands
  • Loading branch information
iulusoy authored Jan 25, 2024
1 parent f4927ea commit 3a29f57
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions unit4/STEPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ sphinx-quickstart
```
Typoe `y`, the name of your project, the author names, the project release (ie. 0.1), language `en`.

Open `conf.py` and uncomment
Open `source/conf.py` and put in
```
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../../src/'))
```
Replace `sys.path.insert(0, os.path.abspath('.'))` with the path to your package (modules), in my example `sys.path.insert(0, os.path.abspath('../src/'))`.
Activate further extensions through
```
extensions = ['sphinx.ext.autodoc',
'myst-parser',
'myst_parser',
'sphinx.ext.napoleon'
]
```
Expand All @@ -30,7 +29,7 @@ Now you can quickstart the autobuild of the sphinx documentation:
`sphinx-apidoc -o source/ ../src/`
This is a step that often leads to problems later on, so if things don't work out for you let me know and I will take a look.

Type `make html` and you should then find a `index.html` file in your `docs/_build/html/` directory that you can preview using the VSCode HTML preview extension or by opening it from the file menu (opens the browser).
Type `make html` and you should then find a `index.html` file in your `docs/build/html/` directory that you can preview using the VSCode HTML preview extension or by opening it from the file menu (opens the browser).

It should contain the name of your package, the author name and Index/Module index. Your modules should be linked here.

Expand Down

0 comments on commit 3a29f57

Please sign in to comment.