neuroinformatics-unit / HowTo

NIU website on common software problems and their troubleshooting
http://howto.neuroinformatics.dev/
Creative Commons Attribution 4.0 International
9 stars 1 forks source link

Update ssh setup guide #64

Closed niksirbi closed 4 months ago

niksirbi commented 4 months ago

Description

What is this PR

Why is this PR needed? See issue #61.

What does this PR do?

Closes #61 by introducing the following changes:

This PR does not provide an updated "Remote development via VSCode" section, as I plan to write a new standalone how-to guide specifically on this task, based on the discussion in #62.

How to review

It's best to locally build and render the website, as the guide contains many interactive elements (from sphinx-design and myst-markdown):

git clone https://github.com/neuroinformatics-unit/HowTo.git
cd HowTo

# First time only
pip install -r docs/requirements.txt
sphinx-build docs/source docs/build

# Every time you want to update the local build
rm -rf docs/build && sphinx-build docs/source docs/build

# To view website, open docs/buid/index.html