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.

Sign up for GitHub

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

Jump to bottom

Update docs and create a proper user guide #305

Merged
merged 47 commits into from
Jun 3, 2022
Merged

Update docs and create a proper user guide #305

merged 47 commits into from
Jun 3, 2022

Commits on Apr 5, 2022

  1. Update Harmonica description on README.rst

    @santisoler
    santisoler committed Apr 5, 2022
    Configuration menu
    Copy the full SHA
    c22655f View commit details
    Browse the repository at this point in the history

  2. Add sphinx-panels as requirement for building docs

    @santisoler
    santisoler committed Apr 5, 2022
    Configuration menu
    Copy the full SHA
    dab6aad View commit details
    Browse the repository at this point in the history

  3. Hide home page from the TOC

    @santisoler
    santisoler committed Apr 5, 2022
    Configuration menu
    Copy the full SHA
    7457a21 View commit details
    Browse the repository at this point in the history

  4. Minor changes in Sphinx configuration

    @santisoler
    santisoler committed Apr 5, 2022
    Configuration menu
    Copy the full SHA
    de050d3 View commit details
    Browse the repository at this point in the history

  5. Add drafts for a new index, an overview and a user guide

    @santisoler
    santisoler committed Apr 5, 2022
    Configuration menu
    Copy the full SHA
    415e5be View commit details
    Browse the repository at this point in the history

  6. Continue drafting coordinate systems tutorial page

    @santisoler
    santisoler committed Apr 5, 2022
    Configuration menu
    Copy the full SHA
    ca7701a View commit details
    Browse the repository at this point in the history

Commits on Apr 6, 2022

  1. Improve geodetic coordinate system figure and its caption

    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    28d3679 View commit details
    Browse the repository at this point in the history

  2. Replace "coordinates projections" for "map projections"

    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    207a2d1 View commit details
    Browse the repository at this point in the history

  3. Rename figure

    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    9aeffc9 View commit details
    Browse the repository at this point in the history

  4. Add figure for spherical coordinate system

    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    73365c3 View commit details
    Browse the repository at this point in the history

  5. Change admonition type note for important

    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    c402fc4 View commit details
    Browse the repository at this point in the history

  6. Add sphinx_copybutton 

    This extension adds a button to each code block to easily copy their
content.
    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    b2e792f View commit details
    Browse the repository at this point in the history

  7. Move tutorials to user_guide and use jupyter_sphinx 

    Instead of creating the user guide documents as .py scripts intended to
be run by Sphinx gallery example, now the user guide is a set of .rst
files that use the jupyter_sphinx extension for running code cells when
building the docs.
This eases the process of writing user guides and also organize them in
subtrees.
    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    2ca989f View commit details
    Browse the repository at this point in the history

  8. Fix ambiguous reference to citing

    @santisoler
    santisoler committed Apr 6, 2022
    Configuration menu
    Copy the full SHA
    ee5ba70 View commit details
    Browse the repository at this point in the history

Commits on Apr 7, 2022

  1. Fill content in forward modelling with point sources

    @santisoler
    santisoler committed Apr 7, 2022
    Configuration menu
    Copy the full SHA
    465a1f0 View commit details
    Browse the repository at this point in the history

  2. Split big code cells into smaller ones 

    Convert some code comments into rst text with proper links.
    @santisoler
    santisoler committed Apr 7, 2022
    Configuration menu
    Copy the full SHA
    226bc62 View commit details
    Browse the repository at this point in the history

  3. Change title of subsubsection

    @santisoler
    santisoler committed Apr 7, 2022
    Configuration menu
    Copy the full SHA
    fde78bf View commit details
    Browse the repository at this point in the history

Commits on Apr 11, 2022

  1. Remove repeated definition of point source

    @santisoler
    santisoler committed Apr 11, 2022
    Configuration menu
    Copy the full SHA
    54b6de6 View commit details
    Browse the repository at this point in the history

  2. Add guide for modelling prisms

    @santisoler
    santisoler committed Apr 11, 2022
    Configuration menu
    Copy the full SHA
    ca48e72 View commit details
    Browse the repository at this point in the history

Commits on Apr 14, 2022

  1. Add margin to paragraphs after jupyter_containers

    @santisoler
    santisoler committed Apr 14, 2022
    Configuration menu
    Copy the full SHA
    74b962e View commit details
    Browse the repository at this point in the history

Commits on Apr 15, 2022

  1. Replace gravity for gravitational

    @santisoler
    santisoler committed Apr 15, 2022
    Configuration menu
    Copy the full SHA
    eb2684b View commit details
    Browse the repository at this point in the history

Commits on Apr 18, 2022

  1. Start writing about tesseroids

    @santisoler
    santisoler committed Apr 18, 2022
    Configuration menu
    Copy the full SHA
    e6d6394 View commit details
    Browse the repository at this point in the history

  2. Fix sentence

    @santisoler
    santisoler committed Apr 18, 2022
    Configuration menu
    Copy the full SHA
    fd2fa7e View commit details
    Browse the repository at this point in the history

  3. Start writing about gravity disturbances

    @santisoler
    santisoler committed Apr 18, 2022
    Configuration menu
    Copy the full SHA
    16e0475 View commit details
    Browse the repository at this point in the history

Commits on Apr 19, 2022

  1. Add more content to gravity disturbance

    @santisoler
    santisoler committed Apr 19, 2022
    Configuration menu
    Copy the full SHA
    fd67bad View commit details
    Browse the repository at this point in the history

  2. Reduce shape of grids in coordinate system

    @santisoler
    santisoler committed Apr 19, 2022
    Configuration menu
    Copy the full SHA
    0e4dcda View commit details
    Browse the repository at this point in the history

  3. Fix proper reference label to gravity disturbance

    @santisoler
    santisoler committed Apr 19, 2022
    Configuration menu
    Copy the full SHA
    bec99e6 View commit details
    Browse the repository at this point in the history

Commits on Apr 20, 2022

  1. Add topographic correction page to user guide

    @santisoler
    santisoler committed Apr 20, 2022
    Configuration menu
    Copy the full SHA
    0ab33ce View commit details
    Browse the repository at this point in the history

Commits on Apr 22, 2022

  1. Use ensaio in the new user guide

    @santisoler
    santisoler committed Apr 22, 2022
    Configuration menu
    Copy the full SHA
    80b2281 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into improve-docs

    @santisoler
    santisoler authored Apr 22, 2022
    Configuration menu
    Copy the full SHA
    cf57541 View commit details
    Browse the repository at this point in the history

Commits on May 23, 2022

  1. Merge branch 'main' into improve-docs

    @santisoler
    santisoler authored May 23, 2022
    Configuration menu
    Copy the full SHA
    567e248 View commit details
    Browse the repository at this point in the history

  2. Add custom CSS for the jupyter-sphinx code blocks

    @santisoler
    santisoler committed May 23, 2022
    Configuration menu
    Copy the full SHA
    7c92439 View commit details
    Browse the repository at this point in the history

  3. Update topographic correction guide 

    Use the new gravity dataset for Bushveld from Ensaio
    @santisoler
    santisoler committed May 23, 2022
    Configuration menu
    Copy the full SHA
    58d2a79 View commit details
    Browse the repository at this point in the history

  4. Merge branch 'improve-docs' of github.com:fatiando/harmonica into imp… 

    …rove-docs
    @santisoler
    santisoler committed May 23, 2022
    Configuration menu
    Copy the full SHA
    760758d View commit details
    Browse the repository at this point in the history

  5. Start adding pages for equivalent sources

    @santisoler
    santisoler committed May 23, 2022
    Configuration menu
    Copy the full SHA
    b4d0106 View commit details
    Browse the repository at this point in the history

Commits on May 24, 2022

  1. Add user guide for estimating eqs hyperparameters

    @santisoler
    santisoler committed May 24, 2022
    Configuration menu
    Copy the full SHA
    e8fcc87 View commit details
    Browse the repository at this point in the history

Commits on May 27, 2022

  1. Improve some toctrees 

    Also remove the Regular equivalent sources subtitle (no needed)
    @santisoler
    santisoler committed May 27, 2022
    Configuration menu
    Copy the full SHA
    4949efa View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into improve-docs

    @santisoler
    santisoler committed May 27, 2022
    Configuration menu
    Copy the full SHA
    d16c4a0 View commit details
    Browse the repository at this point in the history

  3. Generate grids in user guide with the new coordinates argument

    @santisoler
    santisoler committed May 27, 2022
    Configuration menu
    Copy the full SHA
    1781d5f View commit details
    Browse the repository at this point in the history

  4. Add content to the block-averaged equivalent sources page

    @santisoler
    santisoler committed May 27, 2022
    Configuration menu
    Copy the full SHA
    27012d3 View commit details
    Browse the repository at this point in the history

Commits on May 31, 2022

  1. Merge branch 'main' into improve-docs

    @santisoler
    santisoler authored May 31, 2022
    Configuration menu
    Copy the full SHA
    7cb3e0f View commit details
    Browse the repository at this point in the history

  2. Add guide for gradient-boosted equivalent sources

    @santisoler
    santisoler committed May 31, 2022
    Configuration menu
    Copy the full SHA
    aff7915 View commit details
    Browse the repository at this point in the history

  3. Fix broken links

    @santisoler
    santisoler committed May 31, 2022
    Configuration menu
    Copy the full SHA
    fda47b5 View commit details
    Browse the repository at this point in the history

  4. Fix broken links

    @santisoler
    santisoler committed May 31, 2022
    Configuration menu
    Copy the full SHA
    1ab1cde View commit details
    Browse the repository at this point in the history

Commits on Jun 1, 2022

  1. Add content to equivalent sources in spherical coordinates

    @santisoler
    santisoler committed Jun 1, 2022
    Configuration menu
    Copy the full SHA
    f30a73f View commit details
    Browse the repository at this point in the history

  2. Add doc/versions.rst file

    @santisoler
    santisoler committed Jun 1, 2022
    Configuration menu
    Copy the full SHA
    76c0ca8 View commit details
    Browse the repository at this point in the history

Commits on Jun 3, 2022

  1. Make home admonition more welcoming

    @santisoler
    santisoler committed Jun 3, 2022
    Configuration menu
    Copy the full SHA
    d0376ba View commit details
    Browse the repository at this point in the history