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

DOC: Deploy docs to gh-pages from CircleCI - with versioning #65

Merged
merged 67 commits into from
Oct 11, 2019
Merged

DOC: Deploy docs to gh-pages from CircleCI - with versioning #65

merged 67 commits into from
Oct 11, 2019

Commits on Mar 25, 2019

  1. initial docs commit

    @rwblair
    rwblair committed Mar 25, 2019
    Configuration menu
    Copy the full SHA
    a895c7f View commit details
    Browse the repository at this point in the history

  2. add doc build and deploy to workflow.

    @rwblair
    rwblair committed Mar 25, 2019
    Configuration menu
    Copy the full SHA
    3e0f388 View commit details
    Browse the repository at this point in the history

Commits on Mar 26, 2019

  1. fix indentation of docs jobs in config.yml

    @rwblair
    rwblair committed Mar 26, 2019
    Configuration menu
    Copy the full SHA
    ff1798e View commit details
    Browse the repository at this point in the history

  2. more indents in config.yml

    @rwblair
    rwblair committed Mar 26, 2019
    Configuration menu
    Copy the full SHA
    35624db View commit details
    Browse the repository at this point in the history

  3. ensure sphinx installed for docs

    @rwblair
    rwblair committed Mar 26, 2019
    Configuration menu
    Copy the full SHA
    d0f9048 View commit details
    Browse the repository at this point in the history

Commits on Mar 29, 2019

  1. apidoc wont make a directory for you.

    @rwblair
    rwblair committed Mar 29, 2019
    Configuration menu
    Copy the full SHA
    50f713d View commit details
    Browse the repository at this point in the history

Commits on Apr 1, 2019

  1. only build docs if push to pypi and docker works, only push docs if a… 

    … tag exists
    @rwblair
    rwblair committed Apr 1, 2019
    Configuration menu
    Copy the full SHA
    1ee14cd View commit details
    Browse the repository at this point in the history

Commits on Jul 15, 2019

  1. Merge branch 'master' of github.com:poldracklab/smriprep into ci_doc_… 

    …deploy
    @rwblair
    rwblair committed Jul 15, 2019
    Configuration menu
    Copy the full SHA
    ae493f6 View commit details
    Browse the repository at this point in the history

  2. change in apidoc command, should fail missing dot command now

    @rwblair
    rwblair committed Jul 15, 2019
    Configuration menu
    Copy the full SHA
    d8a6165 View commit details
    Browse the repository at this point in the history

Commits on Jul 17, 2019

  1. try building docs even if not deploying them

    @rwblair
    rwblair committed Jul 17, 2019
    Configuration menu
    Copy the full SHA
    ec8d3a8 View commit details
    Browse the repository at this point in the history

Commits on Aug 27, 2019

  1. install sphinx-versioning from github

    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    7e901e1 View commit details
    Browse the repository at this point in the history

  2. add apidoc to docs/conf.py

    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    505bc4e View commit details
    Browse the repository at this point in the history

  3. change how apidoc output is referenced in index.rst

    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    3ce213c View commit details
    Browse the repository at this point in the history

  4. remove old api.rst

    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    f0c9f7c View commit details
    Browse the repository at this point in the history

  5. put doc requirements in their own file instead of only in ci config

    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    c2e5dd0 View commit details
    Browse the repository at this point in the history

  6. add -e to github install for sphinx-versioning

    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    909baa5 View commit details
    Browse the repository at this point in the history

  7. call pip properly in build_docs in circle config

    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    04991ea View commit details
    Browse the repository at this point in the history

  8. use remove apidoc call in circle, use sphinx-versioning. Save documen… 

    …ts as artifact.
    @rwblair
    rwblair committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    809ae0e View commit details
    Browse the repository at this point in the history

Commits on Aug 28, 2019

  1. Update docs/Makefile 

    Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
    @rwblair @oesteban
    rwblair and oesteban authored Aug 28, 2019
    Configuration menu
    Copy the full SHA
    3910d09 View commit details
    Browse the repository at this point in the history

  2. Update docs/conf.py 

    Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
    @rwblair @oesteban
    rwblair and oesteban authored Aug 28, 2019
    Configuration menu
    Copy the full SHA
    51a3ef9 View commit details
    Browse the repository at this point in the history

  3. Update docs/api/smriprep.rst 

    Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
    @rwblair @oesteban
    rwblair and oesteban authored Aug 28, 2019
    Configuration menu
    Copy the full SHA
    6268213 View commit details
    Browse the repository at this point in the history

  4. Update docs/api/smriprep.rst 

    Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
    @rwblair @oesteban
    rwblair and oesteban authored Aug 28, 2019
    Configuration menu
    Copy the full SHA
    1a5b94e View commit details
    Browse the repository at this point in the history

  5. Deploy for any tag, not just ones that start with v 

    Move docs requirements to docs directory
pin sphinxcontrib-versioning to a tag
remove subsection header in api/smriprep.rst
Have versions in docs/conf.py match fmriprep
Try moving subpacge toctree to smriprep/__init__.py
    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    d5cf408 View commit details
    Browse the repository at this point in the history

  6. Merge branch 'ci_doc_deploy' of github.com:poldracklab/smriprep into … 

    …ci_doc_deploy
    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    d85ff5b View commit details
    Browse the repository at this point in the history

  7. set a templatedir for apidoc

    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    08122d7 View commit details
    Browse the repository at this point in the history

  8. move autodoc templates into _templates. Minor removals inside package… 

    ….rst_t
    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    ffabae2 View commit details
    Browse the repository at this point in the history

  9. remove 'subpackages' header from main smriprep toctree

    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    062d18d View commit details
    Browse the repository at this point in the history

  10. Let apidoc build the files in docs/api

    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    8ec2bdb View commit details
    Browse the repository at this point in the history

  11. autodoc builds for workflows failed when called by sphinx-versioning … 

    …without pytest.
    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    5eaf33e View commit details
    Browse the repository at this point in the history

  12. circle needs to install graphviz

    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    3f99224 View commit details
    Browse the repository at this point in the history

  13. fixed circle config syntax error

    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    e2b5d9f View commit details
    Browse the repository at this point in the history

  14. fix for circle, python docker runs as root by default

    @rwblair
    rwblair committed Aug 28, 2019
    Configuration menu
    Copy the full SHA
    5cba911 View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2019

  1. modernize pybids import

    @rwblair
    rwblair committed Aug 29, 2019
    Configuration menu
    Copy the full SHA
    ee24073 View commit details
    Browse the repository at this point in the history

Commits on Aug 30, 2019

  1. tweak package template, only show toctree for each package.

    @rwblair
    rwblair committed Aug 30, 2019
    Configuration menu
    Copy the full SHA
    9340f23 View commit details
    Browse the repository at this point in the history

  2. fix: remove docs/_sources // several improvements

    @oesteban
    oesteban committed Aug 30, 2019
    Configuration menu
    Copy the full SHA
    76556f6 View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2019

  1. fix: improving template, slow apidoc down

    @oesteban
    oesteban committed Aug 31, 2019
    Configuration menu
    Copy the full SHA
    b2e72e7 View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2019

  1. set fsloutput env variable to quiet the warnings when building docs

    @rwblair
    rwblair committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    377799a View commit details
    Browse the repository at this point in the history

Commits on Oct 1, 2019

  1. ignore modules.rst generated by apidoc, fix indent issues and standar… 

    …dize headers in workflows/base.py docs. Remove trailing underscore from freesurfer in surfaces.py
    @rwblair
    rwblair committed Oct 1, 2019
    Configuration menu
    Copy the full SHA
    268647b View commit details
    Browse the repository at this point in the history

  2. remove bidslayout import replace with named tuple

    @rwblair
    rwblair committed Oct 1, 2019
    Configuration menu
    Copy the full SHA
    f9b8557 View commit details
    Browse the repository at this point in the history

  3. add import for namedtuple

    @rwblair
    rwblair committed Oct 1, 2019
    Configuration menu
    Copy the full SHA
    581705f View commit details
    Browse the repository at this point in the history

  4. Merge branch 'master' into ci_doc_deploy

    @oesteban
    oesteban authored Oct 1, 2019
    Configuration menu
    Copy the full SHA
    c6e49f9 View commit details
    Browse the repository at this point in the history

  5. validate is not a kwarg for namedtuples, removing in base.py

    @rwblair
    rwblair committed Oct 1, 2019
    Configuration menu
    Copy the full SHA
    9a1f948 View commit details
    Browse the repository at this point in the history

  6. have init_anat_norm_wf doc argument match actual argument name

    @rwblair
    rwblair committed Oct 1, 2019
    Configuration menu
    Copy the full SHA
    68ec087 View commit details
    Browse the repository at this point in the history

  7. convert templates from list to tuple in norm.py

    @rwblair
    rwblair committed Oct 1, 2019
    Configuration menu
    Copy the full SHA
    47112ef View commit details
    Browse the repository at this point in the history

  8. remote another trailing underscore for freesurfer in docs. 

    Run sphinx-build with -W before sphinx-versioning to ensure no warnings.
    @rwblair
    rwblair committed Oct 1, 2019
    Configuration menu
    Copy the full SHA
    a9722e5 View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2019

  1. have pytest test use python 3.6 as required by twine package

    @rwblair
    rwblair committed Oct 2, 2019
    Configuration menu
    Copy the full SHA
    05dadf8 View commit details
    Browse the repository at this point in the history

  2. set python version for pytest test to one that pyenv has access to on… 

    … that particular machine image
    @rwblair
    rwblair committed Oct 2, 2019
    Configuration menu
    Copy the full SHA
    3bfa7e7 View commit details
    Browse the repository at this point in the history

  3. bump sphinxcontrib-versioning version to allow default sidebar entrie… 

    …s to display
    @rwblair
    rwblair committed Oct 2, 2019
    Configuration menu
    Copy the full SHA
    44aae1d View commit details
    Browse the repository at this point in the history

  4. use python docker image instead of circle machine image

    @rwblair
    rwblair committed Oct 2, 2019
    Configuration menu
    Copy the full SHA
    88f0684 View commit details
    Browse the repository at this point in the history

  5. add --user flag for pytest test pip command

    @rwblair
    rwblair committed Oct 2, 2019
    Configuration menu
    Copy the full SHA
    cbdfd5b View commit details
    Browse the repository at this point in the history

  6. add --user flag for pytest test pip command

    @rwblair
    rwblair committed Oct 2, 2019
    Configuration menu
    Copy the full SHA
    8261eef View commit details
    Browse the repository at this point in the history

Commits on Oct 4, 2019

  1. pin python version when building docs. Use makefile to build docs

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    53e9493 View commit details
    Browse the repository at this point in the history

  2. add back in freesurfer link remove pytest as requirement

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    c331167 View commit details
    Browse the repository at this point in the history

  3. have build_docs in ci cd to docs dir

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    534642d View commit details
    Browse the repository at this point in the history

  4. copy fmriprep makefile

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    67d1bef View commit details
    Browse the repository at this point in the history

  5. use make to change dirs in stead of using seperate command in circle … 

    …config
    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    3f38183 View commit details
    Browse the repository at this point in the history

  6. fix sphinxversioning call in makefile and circle conf

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    dc59b3e View commit details
    Browse the repository at this point in the history

  7. sphinx-versioning needs to be called in the directory above docs/ to … 

    …work properly. changing circle config to reflect that. Update theme to rtd theme
    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    e0075d9 View commit details
    Browse the repository at this point in the history

  8. cache versioned docs output to preserve html for previously build tags

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    6f7440c View commit details
    Browse the repository at this point in the history

  9. fix unmatched quote in circle config...

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    ece60db View commit details
    Browse the repository at this point in the history

  10. actually validate circle config before pushing

    @rwblair
    rwblair committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    09a9e44 View commit details
    Browse the repository at this point in the history

Commits on Oct 7, 2019

  1. DOC: Restore FreeSurfer link

    @effigies
    effigies committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    e3841e0 View commit details
    Browse the repository at this point in the history

  2. update setup.cfg requirements for docs

    @rwblair
    rwblair committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    70394aa View commit details
    Browse the repository at this point in the history

  3. DOC: Move links to docstring to avoid weird sphinx warning

    @effigies
    effigies committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    ae68918 View commit details
    Browse the repository at this point in the history

  4. Merge branch 'ci_doc_deploy' of github.com:poldracklab/smriprep into … 

    …ci_doc_deploy
    @rwblair
    rwblair committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    f491a0c View commit details
    Browse the repository at this point in the history

Commits on Oct 10, 2019

  1. bump nipype version

    @rwblair
    rwblair committed Oct 10, 2019
    Configuration menu
    Copy the full SHA
    cf74799 View commit details
    Browse the repository at this point in the history

  2. bump pybids version

    @rwblair
    rwblair committed Oct 10, 2019
    Configuration menu
    Copy the full SHA
    b539115 View commit details
    Browse the repository at this point in the history