search

codereport / jsource

J Language Source Code. Livestream links ⬇️
https://www.youtube.com/playlist?list=PLVFrD1dmDdvfVhYLU_iKkV67X9XqCJLWe
Other
38 stars 20 forks source link

Document prerequisites for building docs #127

Closed juntuu closed 3 years ago

juntuu commented 3 years ago

Building the documentation requires some additional tools and packages. I did not find these documented anywhere in the repo yet.

These could be listed in the CONTRIBUTING.md.

Sebanisu commented 3 years ago

https://youtu.be/fvzZ2DkmHlY he set it up during this livestream.

Sebanisu commented 3 years ago

Trying to build docs: I don't get why it says /usr/bin/sphinx-build: not found when it's in my PATH in another folder. :/

pip3 install -U sphinx
pip3 install divio-docs-theme
pip3 install breathe

I had to add the PATH to sphinx to ~/.bashrc so it's set every boot.

rm -rf build
cmake -G "Ninja Multi-Config" -B build -DDOCS:STRING=YES

There is an Ubuntu package for sphinx but it's really out of date.