docs: Issues

[svx]

Currently the docs here have various issues.

• wrong reST syntax for example on index.rst (including documents = :doc:)
• linking to non existing files
• various warings if you build the docs of bobtemplates.plone with the latest Sphinx version.

It would be awesome to fix these issues, remember we also include the docs on docs.plone.org and currently reading these docs here on docs.plone.org is not as awesome for the user as it could be :)

Thanks !

PS: I lost already too much time to fix some of these mentioned above on my local build which I push for now to docs.plone.org.

Ping me if I can push a improved version :)

Have a nice weekend !

[MrTango]

I'm not sure how i can verify this. We have aare generating the Sphinx docs with tox:

tox -e docs

and it does not give any warning. What are the excact problems, if they still exist?

[MrTango]

@svx is this still valid? If so how can we test this with tox/travis?

[svx]

@MrTango I have to check again.

In general, not sure about tox since I do not use that.

Testing with any CI works !

I have currently limited time, because of day work and lots of changes/preparations related to Plone 6 documentation.

If I am able to find some time I will check again !