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

Documenter failiing to include documentation even with 2autodocs or explicit @dcs blocks #2632

Open
MarkNahabedian opened this issue Feb 14, 2025 · 0 comments

Comments

@MarkNahabedian
Copy link
Contributor

One of my projects, Rete.jl
is failing its documentation build both in its CI GitHub action
and locally.

This problem is blocking a new release of this registered package,

This documentetion used to build, as evidenced by the repository's
gh-pages branch and the actions report for CI #70. For some reason,
the GitHub web UI doesn’t believe that it’s users might want to know
the date and time of a given CI run despite GitHub being a tool that
is all about history.

┌ Error: Cannot resolve @ref for md"AbstractReteNode" in src/index.md.
│ - No docstring found in doc for binding Rete.AbstractReteNode.
│ - No docstring found in doc for binding Rete.AbstractReteNode.
└ @ Documenter ~/.julia/packages/Documenter/Bs999/src/utilities/utilities.jl:44
[ Info: CheckDocument: running document checks.
┌ Error: 42 docstrings not included in the manual:
│
│ Rete.fact_count :: Tuple{AbstractReteNode}
│ Rete.add_forward_trigger :: Tuple{JoinNode, AbstractReteNode}
...
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in canonical @docs or @autodocs blocks.
└ @ Documenter ~/.julia/packages/Documenter/Bs999/src/utilities/utilities.jl:44
[ Info: Populate: populating indices.
ERROR: LoadError: makedocs encountered errors [:missing_docs, :cross_references] – terminating build before rendering.

I don't know why these doc strings are not included. The index.md
file includes an @autodocs block.

Even if I include all of the listed names in an explicit @docs
block, I still get the same error.

Am I doing something wrong or is Documenter.jl broken?

From Documenter's Project.toml:

name = “Documenter”
uuid = “e30172f5-a6a5-5a46-863b-614d45cd2de4”
version = “1.8.0”

Thanks.

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

No branches or pull requests

1 participant