Skip to content
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

Refactor the documentation into separate pages #202

Merged
merged 9 commits into from
Aug 6, 2020
Merged

Commits on Jul 31, 2020

  1. Configuration menu
    Copy the full SHA
    3b8b809 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    4ab842d View commit details
    Browse the repository at this point in the history
  3. Refactor the documentation into separate pages

    Break up the usage documentation into separate pages: basic usage
    (Training your Pooch with some elements removed), single file downloads,
    downloaders, processors, and advanced tricks. Moved the processor and
    downloader specifications from the docstring of Pooch.fetch to the
    respective pages and link to them from the docstrings. Also did general
    updates to the docstrings (for example, to include the new retrieve
    function) and tutorials. Separated the side menu into Getting Started,
    User Guide, and Reference Documentation like in all other projects.
    leouieda committed Jul 31, 2020
    Configuration menu
    Copy the full SHA
    2d65585 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    441d8e7 View commit details
    Browse the repository at this point in the history

Commits on Aug 1, 2020

  1. Separate tutorial into 3 levels

    Add an intermediate level tutorial
    leouieda committed Aug 1, 2020
    Configuration menu
    Copy the full SHA
    ebb105e View commit details
    Browse the repository at this point in the history

Commits on Aug 3, 2020

  1. Reorganize the tutorial levels

    Move things between them so that the beginner tutorial is really minimal
    leouieda committed Aug 3, 2020
    Configuration menu
    Copy the full SHA
    9179cec View commit details
    Browse the repository at this point in the history
  2. Make the retrieve tutorial the first contact

    Start with retrieve and include links to setting up Pooch through the
    beginner tutorial
    leouieda committed Aug 3, 2020
    Configuration menu
    Copy the full SHA
    6bafcf7 View commit details
    Browse the repository at this point in the history
  3. Rename GOODBOY to POOCH and clarify what it is

    Added some docs explaining what the return of create is.
    leouieda committed Aug 3, 2020
    Configuration menu
    Copy the full SHA
    60af2fa View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    61025f4 View commit details
    Browse the repository at this point in the history