Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

:type: SOMETYPE rendered in sphinx documentation #161

Open
anders-kiaer opened this issue Sep 10, 2020 · 3 comments
Open

:type: SOMETYPE rendered in sphinx documentation #161

anders-kiaer opened this issue Sep 10, 2020 · 3 comments
Labels
bug Something isn't working

Comments

@anders-kiaer
Copy link

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

In equinor/flownet#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
Copy link
Contributor

lars-petter-hauge commented Sep 18, 2020

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
Copy link
Author

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
Copy link
Collaborator

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

@markusdregi markusdregi added the bug Something isn't working label Sep 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants