Re: antora referencing source beneath src folder
Posted by
David Jencks on
Apr 24, 2020; 2:37pm
URL: https://discuss.asciidoctor.org/antora-referencing-source-beneath-src-folder-tp7953p7954.html
Right now in Antora included content has to be in the antora structure.
There’s some more flexibility available than you may be aware of through using distributed components, where you can have several antora structured source trees contributing to the same component/version, either in different repos or the same repo at multiple start paths. I think the documentation for this has been updated extensively recently.
There are two directions of extension being considered, probably for Antora 3:
- adding sources to the Antora content catalog from non-default locations. Such a location could be an alternate path in an already-known git repo, or an external source such as a javadoc jar. (those are two choices I’ve prototyped). After the content gets catalogued, you refer to it using an antora resource id.
- remote includes, where an include:: points to a URL not in a known git repo.
In the projects I’m aware of with this problem right now, which are large java projects that need to transfer content from a maven-based build location associated with the java source to an antora structure, there are build scripts that copy the source into the antora structure, where it’s checked in to git.
Hope this helps,
David Jencks
On Apr 24, 2020, at 4:48 AM, ante [via Asciidoctor :: Discussion] <
[hidden email]> wrote:
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
or is it bad practice to do it like that and should i only use code transferred to module/<module-name>/examples?
i am not sure, but i think i found once a dicsussion on that but cannot find it anymore...
does anybody have an advice on that?
thanks for reply!