How to give path to srctree?

[schodet]

Hello,

the only way I found to give the path to srctree is to export the srctree variable before calling sphinx-build.

Is there a way to do it from the conf.py file?

Thanks.

Edit: s/srcdir/srctree/g

[return42]

What do you want to do?

srctreeis only needed here https://return42.github.io/linuxdoc/linux.html .. but this article left there for historical reasons (see remark box in the right upper corner).

[schodet]

I have my documentation in the doc directory, and my code in the parent directory, how should I point to a source file?

I tried relative path:

WARN: no relative pathname given / no SRCTREE:  features based on these settings might not work as expected!                                                                                                        
ERROR: no source file given!
…
/home/nicolas/work/.../api.rst:8: WARNING: kernel-doc refers to nonexisting document 

.. kernel-doc:: ../../src/api.h
…

Did I miss something?

[return42]

Did I miss something?

Sorry, my fail .. there was a mess with the srctree environment. I fixed it 687a8e8 ...

The argument <src-filename> is required and points to the source file. The pathname is relative to the pathname of the kernel-doc directive. Absolute pathnames are relative to environment srctree (if unset, defaults to CWD).

Do you like to pull from master and test it? / Thanks!

[schodet]

Just tested it, it works.

However, it breaks compatibility with what’s is in the kernel tree, not sure it’s right.

It would be also nice to have an option in conf.py to set the srctree.

By the way, you said that “something in kernel’s doc-build chain has been changed”, what changed exactly? What are your future plans for linuxdoc?

[return42]

However, it breaks compatibility with what’s is in the kernel tree, not sure it’s right.
By the way, you said that “something in kernel’s doc-build chain has been changed”, what changed exactly?

Linuxdoc was not made to compile linux's kernel documentation (see below).

When I started the project, the linux build chain to build the docs was simple but today there are a lot of perl scripts needed to do some "pre-compile" stuff and handle tasks that are typical for the kernel project but not for a common project (kernel development is special). E.g. the media tree needs some of these perl scripts and the sphinx command is very sprawling --> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/Makefile#n75

Today, if one wants a different theme for the kernel docs, I recommend to patch the sphinx theme in the kernel.

What are your future plans for linuxdoc?

I don't have any concrete plans ... except fixing the sphinx C domain issues when sphinx has consolidated it.

The kernel-doc markup (and the man builder) is just one feature of the linuxdoc package, other topics are Scalable figure and image handling or diff friendly table markup. I use this sphinx extensions in many projects.

It would be also nice to have an option in conf.py to set the srctree.

If I have time, I will add it ...

[schodet]

Thanks, I think the ticket can be closed.

About adding the option, I will give it a try.

[schodet]

I opened #9 for the configuration item.