How to build with Sphinx Collections?

[anugrahjo]

Is there an example package where 'Sphinx Collections' is used? Inside conf.py, I set 'collections' with a dict for copying a folder but it doesn't seem to do anything during the build. Should I add sphinx_collections to the list of extensions in conf.py? In general, what changes should I make on my original repository to use 'Sphinx Collections'?

[jgarte]

Hi @anugrahjo,

Yes, you should be adding sphinx.collections to your conf.py file similar to here or here.

We have a related ticket open to create a better example project for showing off sphinx-collections: #10

Can you share the project repository that you are working on?

[anugrahjo]

Hi @jgarte,

I see, thanks. It should be sphinxcontrib.collections by the way. I have tried all possible names for the extension before raising this issue. It would be nice to add it to the Introduction in the documentation. Everything else was pretty clear in the docs, but the extension name to be used in conf.py couldn't be found anywhere.

I am working on a template repository for documentation and testing for my lab. It does not do much. Do you still need it?

[jgarte]

@danwos

See @anugrahjo 's comment regarding sphinxcontrib.collections. What do you think?

I am working on template repository for documentation and testing for my lab. It does not do much. Do you still need it?

If you end up finishing the example feel free to share it. Any examples of how people are using sphinx-collections would be great.

[anugrahjo]

@jgarte
Sure, once the documentation template is final, I will share it here.