Login  Register

antora referencing source beneath src folder

Posted by ante on Apr 24, 2020; 11:48am
URL: https://discuss.asciidoctor.org/antora-referencing-source-beneath-src-folder-tp7953.html

hi all,

i managed to convince my teammembers to use asciidoc + antora and we set it up and it is running fine.
but i wonder how to organize my dirs and files when i want to reference (include:link) code the antora way when it is not located within the antora related content tree, i.e. the actual source of a component

current file structure

component
|_ docs/...
|   |_ antora.yml
|   |_ module-x
|         |_ pages
|         |    |_ about_modules.adoc
|         |_ examples
|             |_ copy_some_module.py
|_ src
    |_ module-x
        |_ some_module.py

while I know that referencing some_module.py with include::<module-name>:some_module.py[tag=...] with that structure will not work, i can only copy it to examples folder in order to include it the antora way...

i am not sure, but i think i found once a dicsussion on that, but cannot find it anymore...
so do you have ideas on how to handle source content in folder-foreign locations like that or
 is it just not meant to be used that way?

thanks for reply!