Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Question] make -C docs fails #143

Open
pwintz opened this issue Nov 10, 2022 · 1 comment
Open

[Question] make -C docs fails #143

pwintz opened this issue Nov 10, 2022 · 1 comment
Labels
question Further information is requested

Comments

@pwintz
Copy link

pwintz commented Nov 10, 2022

When I run make -C docs, I get an error that says docs/qsort-example-docs/contents.rst not found. Any advice how to fix this would be helpful.

pwintz-2-in-1:~/code/scarab
$ make -C docs
make: Entering directory '/home/pwintz/code/scarab/docs'
make docs -C ../src
make html -C qsort-example-docs
make[1]: Entering directory '/home/pwintz/code/scarab/docs'
make[1]: warning: jobserver unavailable: using -j1.  Add '+' to parent make rule.
make[1]: Entering directory '/home/pwintz/code/scarab/docs'
make[1]: warning: jobserver unavailable: using -j1.  Add '+' to parent make rule.
make[1]: *** No rule to make target 'docs'.  Stop.
make[1]: Leaving directory '/home/pwintz/code/scarab/src'
make: *** [Makefile:8: scarab-src] Error 2
make: *** Waiting for unfinished jobs....
Running Sphinx v1.8.5
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index

Sphinx error:
master file /home/pwintz/code/scarab/docs/qsort-example-docs/contents.rst not found
make[1]: *** [Makefile:23: html] Error 2
make[1]: Leaving directory '/home/pwintz/code/scarab/docs/qsort-example-docs'
make: *** [Makefile:11: qsort-example] Error 2
make: Leaving directory '/home/pwintz/code/scarab/docs'
@pwintz pwintz added the question Further information is requested label Nov 10, 2022
@kofyou
Copy link

kofyou commented Feb 23, 2023

I tried the following and the doc compiles (but something seems still missing).

  1. git checkout cbd0d7b (this is probably the latest version that still support the doc to be compiled)
  2. apt-get install python3-sphinx
  3. add this line master_doc = 'index' to scarab/docs/qsort-example-docs/conf.py

I don't think the doc provides additional information on using Scarab. Seems that those scarab/docs/*.md are all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants