ECE387

ECE387 Course Web

How to edit and publish this course web

I recommned vscode to edit and publish it.

How to install required Python packages?

Open a terminal.
Navigate to the root folder and find requirements.txt
run pip install -r requirements.txt for Windows machines
run pip install -r requirements_linux.txt for Linux machines
I recommned using a virtual environment.

How to build and publish?

Run the following under the docs folder.
Build: jupyter-book build --all .
Publish: ghp-import -n -p -f _build/html

Recommended extensions for vscode

Python, Python Extension Pack
Jupyter, MyST-Markdown

Convert jupyter notebook to markdown

jupytext https://jupytext.readthedocs.io/en/latest/using-cli.html
install: pip install jupytext

Settings inside settings.json

{
    "python.envFile": "${workspaceFolder}/.venv",
    "python.terminal.activateEnvInCurrentTerminal": true,
}