BlueBrain / libsonata

A python and C++ interface to the SONATA format
https://libsonata.readthedocs.io/en/stable/
GNU Lesser General Public License v3.0
12 stars 12 forks source link

C++ API documentation not properly displayed #249

Closed 1uc closed 1 year ago

1uc commented 1 year ago

The C++ API documentation published on readthedocs, e.g. https://libsonata.readthedocs.io/en/latest/cpp/doxygen_CircuitConfig.html

doesn't display any useful information, see screenshot. 2023-02-13-093007_2886x1879_scrot

Two other BBPers confirm it's not just a local broswer issue.

1uc commented 1 year ago

There seems to be an "unwrapped" version of the documentation here: https://libsonata.readthedocs.io/en/latest/cpp/classbbp_1_1sonata_1_1_circuit_config.html

This works well for me.

1uc commented 1 year ago

Possibly related to: https://github.com/BlueBrain/sphinx-bluebrain-theme/issues/66

mgeplf commented 1 year ago

Looks like the fix for https://github.com/BlueBrain/sphinx-bluebrain-theme/issues/66 worked: https://libsonata.readthedocs.io/en/stable/cpp/doxygen_CircuitConfig.html

Can you confirm @1uc?

1uc commented 1 year ago

Thank you! I couldn't spot anything broken.

However, when following a link towards the bottom of a long page such as SonataError near the bottom of: https://libsonata.readthedocs.io/en/stable/cpp/doxygen_CircuitConfig.html

Then if the new page is shorter, I see a blank page until I stroll up. If I then reload the short page, the excess white space at the bottom vanishes.

This works well though. Thanks for fixing this.

mgeplf commented 1 year ago

Then if the new page is shorter, I see a blank page until I stroll up. If I then reload the short page, the excess white space at the bottom vanishes.

Huh, strange, I can't recreate that, but my web knowledge is effectively zero, so there are problably ways to do it. Glad you can live with it.

This works well though. Thanks for fixing this.

No problem, thanks for the report. I'll close this up.