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

Building documentation does not seem to work as expected #6

Open
musicinmybrain opened this issue Mar 31, 2023 · 0 comments
Open

Building documentation does not seem to work as expected #6

musicinmybrain opened this issue Mar 31, 2023 · 0 comments

Comments

@musicinmybrain
Copy link

$ gh repo clone mmlabs-mindmaze/mmlib
$ cd mmlib
$ python3.11 -m venv _e
(_e) $ pip install sphinx sphinx-rtd-theme linuxdoc
(_e) $ meson setup _build
(_e) $ ninja -C _build

Both when trying to generate man pages and when trying to generate HTML documentation, there are many errors of the form

/home/ben/src/mmlib/doc/alloc.rst:4: ERROR: Error in "kernel-doc" directive:
unknown option: "headers".

.. kernel-doc:: src/alloc.c
    :module: alloc
    :headers: mmlib.h
    :functions: mm_aligned_alloc, mm_aligned_free

The documentation build “succeeds” but the individual pages that would have been generated via linuxdoc, e.g. _build/doc/html/alloc.html, have no content, the man page build reports WARNING: no "man_pages" config value nor manual section found; no manual pages will be written, and _build/doc/man3/ is empty.

Am I missing something, or is this no longer working as expected with current versions of sphinx and/or linuxdoc?

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