search

equinor / configsuite

Config Suite is the result of recognizing the complexity of software configuration.
Other
7 stars 13 forks source link

:type: SOMETYPE rendered in sphinx documentation #161

Open anders-kiaer opened 4 years ago

anders-kiaer commented 4 years ago

Note: This could also be an "user error". 😄

In https://github.com/equinor/flownet/pull/144 we started using the configsuite sphinx extension.

The generated docs currently include e.g. :type: string for string types (in rendered docs). Expected behavior? If not, any input/feedback on what could be wrong in our case would be nice 🙂

Example of rendered documentation can be seen on https://equinor.github.io/flownet/configuration_file.html.

lars-petter-hauge commented 3 years ago

Although not the most human friendly format as of today, it is expected that the required type of the item should be included. You would not like it to be included?

anders-kiaer commented 3 years ago

Very nice to have it included as now. The issue is regarding the format only, which looks like raw .rst in the browser - e.g. :type: sometype 🙂

markusdregi commented 3 years ago

@anders-kiaer This is not an user error, but probably an error in the generated rst files. Thanks for reporting it 👍