New extension Sphinx-Collections: Get external data into your source folder

[Daniel Woste]

Hi guys,

just a small note for a new extension I'm working on: Sphinx-Collections.

https://sphinx-collections.readthedocs.io/en/latest/

It allows you to automatically add files inside the source folder of your sphinx-project before the build starts.
This may be useful, if you want to

- integrate external docs

- merge multiple sphinx docs into one

- create files based on data and jinja templates

- get files from git repos

- use return values from functions as data
- create symlinks to external source

- ...

Another good thing is, Sphinx-Collections also deals with the clean up and configuration for you.

So maybe give it a try.
I use it to combine several sphinx-projects into one for an overall, all-containing documentation needed by >500 devs of an automotive company.

But be careful, project status is still Beta. E.g. test cases are totally missing right now (shame on me, I know...).

You are also welcome to contribute and extend it by your own, awesome solutions.
https://github.com/useblocks/sphinx-collections

Thank you for your time,
  Daniel

[Jeff McKenna]

Thanks for sharing this news here Daniel (it would be great to see more posts like this about new extensions).

-jeff

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/8375fed1-662a-4f29-b8f5-0acc5dcf5200%40googlegroups.com.