IGNF / road2

NodeJS routing server aggregating several popular routing engines (video presentation (french) : https://peertube.fr/w/75fwFoW2GP8tQSGLUXUpPP)
https://ignf.github.io/road2/
GNU General Public License v3.0
11 stars 3 forks source link

feat(doc) move documentation and init sphinx build #27

Closed jmkerloch closed 1 year ago

jmkerloch commented 1 year ago

closes #14

To build new documentation:

# install aditionnal dependencies
python -m pip install -U -r requirements/documentation.txt
# build it
sphinx-build -b html docs docs/_build

Missing (see #28):

lgrd commented 1 year ago

The main readme.md is not ok. It has to be updated ( l.41 for example).

lgrd commented 1 year ago

I'm doing some tests and I will review your PR today. ;) @jmkerloch

lgrd commented 1 year ago

Could you create an issue for the missing tasks, please ? ^^

jmkerloch commented 1 year ago

Issue for missing info in conf.py : https://github.com/IGNF/road2/issues/28

lgrd commented 1 year ago
$ python -m pip install -U -r requirements/documentation.txt
Collecting myst-parser[linkify]<0.19,>=0.17 (from -r requirements/documentation.txt (line 4))
  Could not find a version that satisfies the requirement myst-parser[linkify]<0.19,>=0.17 (from -r requirements/documentation.txt (line 4)) (from versions: )
No matching distribution found for myst-parser[linkify]<0.19,>=0.17 (from -r requirements/documentation.txt (line 4))

Do you have an idea of what is really missing ?