python-tuf/docs
Jussi Kukkonen 868afda420 docs: Change object attribute doc style
Situation before
* constructor args are not documented
* object attributes are documented
* sphinx cannot show object attribute type annotations
* attribute docs take a lot of vertical space

Now:
* constructor args are documented
* sphinx can show annotated types of constructor args
* class docstring now explains the attributes are the same as
  constructor args (and attributes are not explicitly documented)

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-09-23 17:51:46 +03:00
..
adr Merge pull request #1486 from MVrachev/change-adr8 2021-09-08 13:05:14 +03:00
api docs: Change object attribute doc style 2021-09-23 17:51:46 +03:00
images Add banner_readme.png 2018-01-23 16:36:51 -05:00
latex Fix some typos in docs 2019-02-25 17:00:26 +07:00
AUTHORS.txt Explaining GOVERNANCE structure to better match CNCF graduation ask 2018-10-11 10:50:47 -04:00
CHANGELOG.md Prepare v0.18.1 2021-09-06 13:55:54 +01:00
CLI.md Update CLI.md (#1508) 2021-07-27 20:32:36 -04:00
CODE-OF-CONDUCT.md Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
conf.py docs: Change object attribute doc style 2021-09-23 17:51:46 +03:00
CONTRIBUTORS.rst Update links to account for repository rename 2021-09-01 11:15:33 +01:00
GETTING_STARTED.rst DOC: collapse CLI_EXAMPLES.md into CLI.md 2019-04-08 11:54:10 -04:00
GOVERNANCE.md Update links to account for repository rename 2021-09-01 11:15:33 +01:00
index.rst Update links to account for repository rename 2021-09-01 11:15:33 +01:00
INSTALLATION.rst Update links to account for repository rename 2021-09-01 11:15:33 +01:00
MAINTAINERS.txt Add Teodora to maintainers 2021-08-31 09:57:52 +01:00
METADATA.md Update docs/METADATA.md to reflect recent spec change 2020-03-11 11:35:37 +00:00
OVERVIEW.rst docs: Remove academics files 2021-05-28 17:07:14 -04:00
QUICKSTART.md Update links to account for repository rename 2021-09-01 11:15:33 +01:00
RELEASE.md Update release docs not to mention Python 2 2021-09-06 13:29:51 +01:00
ROADMAP.md Update links to account for repository rename 2021-09-01 11:15:33 +01:00
SECURITY.md Update links to account for repository rename 2021-09-01 11:15:33 +01:00
TAP.rst Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
tuf-spec.0.9.txt fix the outdate url 2021-04-08 10:27:17 +08:00
tuf-spec.md Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
tuf-spec.txt Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
TUTORIAL.md updated docs and comments 2021-07-14 10:37:08 +03:00