New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First version of full documentation #216

Merged
merged 30 commits into from Dec 3, 2018

Conversation

Projects
None yet
2 participants
@jvdzwaan
Member

jvdzwaan commented Nov 23, 2018

Most of the text was taken from the README and existing markdown files (mainly about the integration test framework).

New parts are:

Online version on Read the Docs: https://recipy.readthedocs.io/en/better-docs/

I also added a command to the cli to print the patched modules table (either in plain text or rst format): recipy pm --format plain or recipy pm --format rst

After this is merged, the next step would be to shorten the README and include a link to the online documentation.

jvdzwaan added some commits Oct 14, 2018

Update documentation authors
The authors are now 'the recipy team'.
Add command to print a table with the patched modules
To print the table type: recipy pm

This command uses tabluate. If tabulate isn't installed, an error
message is printed.

Todo:
- add tests for this command
- show warning if the patched modules are empty; this means that
  recipy hasn't been run (the patched modules table is filled every
  time recipy is imported)
Add info about creating patches
Copied from the README.
Update cli help text
So the new subcommands are added.
Update paths for apidocs
Another attempt to fix the module index on readthedocs.
Add section on how recipy works
- update text
- add intersphinx mappings for numpy and pandas
- add autosectionlabel extension for easily creating cross links to
  sections headers
Fix wide tables in RTD theme
See https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html

The patched modules table still doesn't look perfect, unfortunately...
@robintw

This comment has been minimized.

Contributor

robintw commented Dec 3, 2018

Thanks for doing this - sorry I didn't get round to looking at it and merging earlier.

@robintw robintw merged commit 1bc22f7 into master Dec 3, 2018

2 of 4 checks passed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/travis-ci/push The Travis CI build failed
Details
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment