<div dir="ltr"><div dir="ltr">Hi Ryan,<div><br></div><div></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Feb 2, 2021 at 2:53 PM Ryan Long <<a href="mailto:ryan.long@oarcorp.com">ryan.long@oarcorp.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div lang="EN-US" style="overflow-wrap: break-word;">
<div class="gmail-m_-2509383273616906555WordSection1">
<p class="MsoNormal">Hi,<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">I’m working on <a href="https://devel.rtems.org/ticket/4229#ticket" target="_blank">
https://devel.rtems.org/ticket/4229#ticket</a> . The following command is being issued:<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">/home/rlong/nta-workspace/nta-docs/sphinx/bin/sphinx-build -b html -D extensions=sphinxcontrib.bibtex -C . out contents.rst -><u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">If I run this with the “->” at the end, I get “bash: syntax error near unexpected token `newline'” as the erro message. If I run it without the arrow,
<u></u><u></u></p>
<p class="MsoNormal">It prints out the usage, and it says “sphinx-build: error: cannot find files ['contents.rst']”.<u></u><u></u></p>
<p class="MsoNormal"><u></u> </p></div></div></blockquote><div><br></div><div>That -> is not valid bash syntax. I guess that is something out of the waf error logging. You can see where these checks are built in common/waf.py</div><div><br></div><div>contents.rst appears to be something generated dynamically by that waf.py in check_sphinx_extension, so that is not something you can test independently.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div lang="EN-US" style="overflow-wrap: break-word;"><div class="gmail-m_-2509383273616906555WordSection1"><p class="MsoNormal"><u></u></p>
<p class="MsoNormal">I tried adding the recommended configuration settings to each of the conf.py files as sphinxcontrib-bibtex’s documentation recommended, and<u></u><u></u></p>
<p class="MsoNormal">I added “master_doc = 'contents'” to each of them as well based on the warning message from config.log. Neither had any effect.</p></div></div></blockquote><div><br></div><div dir="ltr"><div>I think the master_doc thing is unrelated.</div><div><br></div></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div lang="EN-US" style="overflow-wrap: break-word;"><div class="gmail-m_-2509383273616906555WordSection1"><p class="MsoNormal"><u></u><u></u></p>
<p class="MsoNormal">Does anyone know how to fix this?<u></u><u></u></p>
<p class="MsoNormal"><u></u> </p></div></div></blockquote><div><br></div><div>It looks like the important part is actually this:</div><div><br></div><div>err:<br>Extension error:<br>You must configure the bibtex_bibfiles setting<br><br></div><div>So our waf.py that checks the sphinxcontrib.bibtex extension does not pass through the bibtex_bibfiles setting. </div><div><br></div><div>Since that check uses the -C flag, the config file doesn't get read, so modifying conf.py will bring no joy. That said, we should include that bibtex_bibfiles in our conf.py, so I add that in a separate patch.</div><div><br></div><div>You can create a file contents.rst by hand and put in it the same:</div><div>.. COMMENT sphinx test</div><div><br></div><div>then you can run</div><div>$ sphinx-build -b html -D extensions=sphinx.ext.autodoc -C . out contents.rst<br></div><div>for example<br></div><div><br></div><div>Unfortunately, I can't seem to figure out how to pass the bibtex_bibfiles list to the command line. Everything I tried ends up parsing it into individual characters, e.g.,</div><div>$ touch refs.bib</div><div>$ sphinx-build -b html -D extensions=sphinxcontrib.bibtex -D bibtex_bibfiles=refs.bib -C . out contents.rst<br></div><div><br></div><div>WARNING: could not open bibtex file /mnt/devel/rtems/rtems-docs/build/r.<br>WARNING: could not open bibtex file /mnt/devel/rtems/rtems-docs/build/e.<br>WARNING: could not open bibtex file /mnt/devel/rtems/rtems-docs/build/f.<br>WARNING: could not open bibtex file /mnt/devel/rtems/rtems-docs/build/s.<br></div><div>then it dies because it can't open .</div><div><br></div><div>What I could get to work is to create a minimal config file and pass that:</div><div>$ echo "bibtex_bibfiles = ['refs.bib']" > conf.py<br></div><div>sphinx-build -b html -D extensions=sphinxcontrib.bibtex -c . . out contents.rst<br></div><div><br></div><div>So I made the check rule dynamically create refs.bib and conf.py within the testbuild directory. It might be more elegant to figure out how to pass the _list_ that contains refs.bib in the command line -D version, but this seemed to work.</div><div><br></div><div>I also added the bibtex_bibfiles setting to our common/conf.py file. Please try out the patch I just sent.</div><div><br></div><div>Thanks,</div><div>Gedare</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div lang="EN-US" style="overflow-wrap: break-word;"><div class="gmail-m_-2509383273616906555WordSection1"><p class="MsoNormal"><u></u></p>
<p class="MsoNormal">Thanks,<u></u><u></u></p>
<p class="MsoNormal">Ryan<u></u><u></u></p>
</div>
</div>
_______________________________________________<br>
devel mailing list<br>
<a href="mailto:devel@rtems.org" target="_blank">devel@rtems.org</a><br>
<a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.rtems.org/mailman/listinfo/devel</a></blockquote></div></div>