Clean up and reorganize the RBTools documentation.
Review Request #6794 — Created Jan. 16, 2015 and submitted
This updates the documentation to provide a simpler, more descriptive front page, and to better organize some of the configuration and API pages. The front page starts off with a more fleshed-out description of RBTools, with simple sections on installation and configuration. Each of these point to the relevant pages for the topic. The Installation section no longer has instructions for each OS, but rather links to the new RBTools Downloads page, which has more modern instructions and installers. There's now two configuration pages: One for repository configuration, and one for user configuration. The latter includes configuration of aliases, which is no longer its own page. All the directories now have their own indexes, which are properly chained into toctrees, helping with the organization. Some of the text in various sections was also cleaned up just a bit to flesh out the content and make things more readable.
Built the docs and browsed around. Checked that links were still working
after the intersphinx updates.The docs building didn't show any warnings.
-
-
docs/rbtools/index.rst (Diff revision 1) I think we should remove
[--version]from this, because runningrbt --version postwon't actually run post. -
docs/rbtools/rbt/configuration/users.rst (Diff revision 1) It's weird that this is written in the third person, where pretty much everything else on this page is written in the second.
How about changing things like this:
There's a lot of flexibility when it comes to the RBTools setup. You can provide your own defaults for nearly all RBTools command options, and can define custom aliases to improve your workflows. ... On Linux and MacOS X, this file can be found in your home directory.
Change Summary:
- Removed
--versionfrom the general command usage. - Fixed the wording on the user configuration page.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+189 -203) |
-
Tool: Pyflakes Processed Files: docs/rbtools/_ext/rbt_commands.py docs/rbtools/conf.py Ignored Files: docs/rbtools/rbt/configuration/repositories.rst docs/rbtools/rbt/configuration/index.rst docs/rbtools/index.rst docs/rbtools/api/index.rst docs/rbtools/rbt/configuration/users.rst docs/rbtools/rbt/index.rst docs/rbtools/rbt/commands/index.rst Tool: PEP8 Style Checker Processed Files: docs/rbtools/_ext/rbt_commands.py docs/rbtools/conf.py Ignored Files: docs/rbtools/rbt/configuration/repositories.rst docs/rbtools/rbt/configuration/index.rst docs/rbtools/index.rst docs/rbtools/api/index.rst docs/rbtools/rbt/configuration/users.rst docs/rbtools/rbt/index.rst docs/rbtools/rbt/commands/index.rst
Tool: Pyflakes Processed Files: docs/rbtools/_ext/rbt_commands.py docs/rbtools/conf.py Ignored Files: docs/rbtools/rbt/configuration/repositories.rst docs/rbtools/rbt/configuration/index.rst docs/rbtools/index.rst docs/rbtools/api/index.rst docs/rbtools/rbt/configuration/users.rst docs/rbtools/rbt/index.rst docs/rbtools/rbt/commands/index.rst Tool: PEP8 Style Checker Processed Files: docs/rbtools/_ext/rbt_commands.py docs/rbtools/conf.py Ignored Files: docs/rbtools/rbt/configuration/repositories.rst docs/rbtools/rbt/configuration/index.rst docs/rbtools/index.rst docs/rbtools/api/index.rst docs/rbtools/rbt/configuration/users.rst docs/rbtools/rbt/index.rst docs/rbtools/rbt/commands/index.rst