#sphinx-doc

[02sphinx] 07tk0miya pushed 032 commits to 03stable [+0/-0/±8] 13https://git.io/v63hL

[02sphinx] 07joostvanzwieten 03099b58f - ext.autodoc: fix formatting instance annotations Currently `format_annotation` fails on instances, because instances don't have `__module__` and `__qualname__` attributes. Defer building the `qualified_name` of an annotation until we have established that the annotation is a type.

[02sphinx] 07tk0miya 0383472ac - Merge pull request #2833 from joostvanzwieten/fix-instance-annotations ext.autodoc: fix formatting instance annotations

[02sphinx] 07tk0miya pushed 032 commits to 03master [+0/-0/±2] 13https://git.io/v63hW

[02sphinx] 07mulkieran 031951d55 - Make sure extensions specified with -D override extensions in config file. Previously, a comma separated list of extensions was read and parsed correctly. However, the value was then stored in config hashtable, which was overwritten when the config file was parsed. Now, the config file is parsed first, and the the entry in the config hashtable is updated with the overriding

extension, if it exists. Signed-off-by: mulhern <amulhern@redhat.com>;

[02sphinx] 07tk0miya 030964db7 - Merge pull request #1911 from mulkieran/master-extensions Make sure extensions specified with -D override extensions in config …

[02sphinx] 07tk0miya pushed 032 commits to 03stable [+0/-0/±2] 13https://git.io/v63hz

[02sphinx] 07mulkieran 03189494c - Make sure extensions specified with -D override extensions in config file. Previously, a comma separated list of extensions was read and parsed correctly. However, the value was then stored in config hashtable, which was overwritten when the config file was parsed. Now, the config file is parsed first, and the the entry in the config hashtable is updated with the overriding

extension, if it exists. Signed-off-by: mulhern <amulhern@redhat.com>;

[02sphinx] 07tk0miya 0396b3979 - Update CHANGES for PR#1911

[02sphinx] 07tk0miya pushed 0310 commits to 03master [+0/-0/±23] 13https://git.io/v63hp

[02sphinx] 07tk0miya 03a9da999 - Merge branch 'stable'

Hi, starting out with sphinx here - so excuse the ignorance

Is sphinx a good choice to document a larger project that uses multiple languages and will require a bunch of docs about how the pieces work together?

do you mean multiple programming languages working together or do you mean you will need to translate the documentation to multiple languages or both?

Hasimir, they work together - I got some C/C++, python, tcl and hdl in the project

so a lot of the docs will be how different tools are supposed to interact

so less concern about translating for other countries and more on whether the build for the docs will play nicely with other things

in that case it depends on whether you want to use comments in the code to build the docs or make the docs a separate project

Hasimir, I'll mix it I think - use docstrings for code and write the parts that define how modules work together

Hasimir, Or would you recommend to use sphinx for code docs and something else to write module-level docs?