Repository navigation
Conversation
The shared api_docs_gen workflow installs docs/requirements.txt and runs conan hal docs, which builds docs/conf.py from Doxygen XML. scatter_span had neither, so the job failed on every push and release. The files match strong_ptr and async_context. doxygen.conf is their short config, which emits XML and names the project scatter_span, the name the docs URL uses.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the 📚 Deploy APIs workflow, which has failed on every push and release since the repo was created.
The shared
api_docs_gen.ymlworkflow installsdocs/requirements.txtand then runsconan hal docs, which runs Doxygen and then Sphinx indocs/. scatter_span had norequirements.txtand no Sphinxconf.py, so the job stopped at the install step.Changes
docs/conf.py,docs/requirements.txt,docs/_static/anddocs/_templates/: copied unchanged from strong_ptr. async_context has identical copies.docs/doxygen.conf: replaced the full default Doxyfile with the short config strong_ptr and async_context use. That config emits the XML Sphinx reads (the old one emitted HTML and LaTeX only) and names the projectscatter_spaninstead ofscatter span.conf.pybuilds the version switcher URL from that name:https://libhal.github.io/api/scatter_span/switcher.json.docs/index.rstanddocs/api/: pages forscatter_spanand its iterator,scatter_arrayandspanable, andfor_each_run()..cspell.json: adds thedoxygenclass,doxygenconceptanddoxygenfunctiondirective names.Testing
conan hal docs --doc_version main ./docsbuilds locally with the pinned requirements (Sphinx 8.1.3).