search

duckietown / docs-duckumentation

Other
0 stars 1 forks source link

(Experts) Compiling all books - issues #20

Open sunsibar opened 5 years ago

sunsibar commented 5 years ago

Going through the instructions to compile the book here, for me the following things didn't run as expected:

git submodule init --recursive : Git didn't recognize these options in my case. Is "--recursive" with "submodule init" a deprecated command? I tried using git submodule update --init --recursive instead, as well as starting from scratch with git clone --recurse-submodules, but both did not result in populated submodule directories, even after the below has been fixed.

git submodule update --recursive: Some repositories fail to download, for example:

fatal: repository 'https://github.com/AndreaCensi/docs-robotarium.git/' not found

All except the _sky repositories are now moved to 'github.com/duckietown/repository-name.git'. Updating .gitmodules with new addresses and running git submodule sync seemed to work. Then again running git submodule update --init --recursive did however not populate the submodules.

Lots of errors showed up when running make realclean all -j: All the books failed to compile. Some seems to be fixable by removing the -it parameter in run-book-duckuments-docker.sh in the line after docker_run="docker run.

To remove one more error I copied the folder ./docs/resources to ./resources (relative to the repository "head").

It still fails, however, since submodules have still not been initialized. I'm out of ideas for now. If anyone has some ideas how to make this work, please share.

liampaull commented 5 years ago

In practice these instructions are no longer used in general. We compile everything through the duckietown shell. Simply clone the doc repo you want to build, move inside and run dts docs build. I will leave this open to remind us to update the book documentation.