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

Add Sphinx autodoc and GitHub pages #290

Open
wants to merge 35 commits into
base: master
Choose a base branch
from
Open

Add Sphinx autodoc and GitHub pages #290

wants to merge 35 commits into from

Commits on Nov 7, 2024

  1. Added canonical sphinx workflow

    @alhom
    alhom committed Nov 7, 2024
    Configuration menu
    Copy the full SHA
    2e294e1 View commit details
    Browse the repository at this point in the history

Commits on Nov 8, 2024

  1. set up test branch pointer

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    b68ca0b View commit details
    Browse the repository at this point in the history

  2. Still no requirements.txt, workaround

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    b74cb2d View commit details
    Browse the repository at this point in the history

  3. downgrade version

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    c2556b4 View commit details
    Browse the repository at this point in the history

  4. test

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    5a61336 View commit details
    Browse the repository at this point in the history

  5. Added Sphinx config 

    Added Sphinx config
Fixed Docstrings
Added script to add documentation source files from scripts folder
I did this while in TET training while in University of Helsinki
    @Emerald0X2 @alhom
    Emerald0X2 authored and alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    642b1c8 View commit details
    Browse the repository at this point in the history

  6. Cleaning up test plots and scripts

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    92e5edf View commit details
    Browse the repository at this point in the history

  7. Change sphinx path

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    cf87ee2 View commit details
    Browse the repository at this point in the history

  8. test

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    3a95cec View commit details
    Browse the repository at this point in the history

  9. Merge branch 'add_sphinx' into gh-pages-test

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    dfb0c59 View commit details
    Browse the repository at this point in the history

  10. add the sphinx package to pip...

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    b2ce161 View commit details
    Browse the repository at this point in the history

  11. add correct sphinx via pip...

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    eee8a3f View commit details
    Browse the repository at this point in the history

  12. fix build dir path

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    f6023cc View commit details
    Browse the repository at this point in the history

  13. analysator path fix for sphinx cfg

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    0078058 View commit details
    Browse the repository at this point in the history

  14. another analysator path fix for sphinx cfg

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    f52f15e View commit details
    Browse the repository at this point in the history

  15. Added some script requirements

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    799ce02 View commit details
    Browse the repository at this point in the history

  16. Added "about" page, copyright

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    748b0fd View commit details
    Browse the repository at this point in the history

  17. add the about.rst file

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    0b27432 View commit details
    Browse the repository at this point in the history

  18. fix VLSV link

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    080fa96 View commit details
    Browse the repository at this point in the history

  19. reshuffle about and a WIP notice

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    160744f View commit details
    Browse the repository at this point in the history

  20. saved the reshuffled about.rst...

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    b206b4f View commit details
    Browse the repository at this point in the history

  21. Fix pitchangle.py docstring?

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    aeb8171 View commit details
    Browse the repository at this point in the history

  22. fix filenames docstring

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    47b3005 View commit details
    Browse the repository at this point in the history

  23. Fix plot_colormap docstring indentation

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    18d7d8f View commit details
    Browse the repository at this point in the history

  24. Actually fix filename dosctring?

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    0121568 View commit details
    Browse the repository at this point in the history

  25. plot_colormap code-block indentation

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    3d2929b View commit details
    Browse the repository at this point in the history

  26. plot_colormap3dslice, isosoruface indent fixes

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    05e7a38 View commit details
    Browse the repository at this point in the history

  27. change to master

    @alhom
    alhom committed Nov 8, 2024
    Configuration menu
    Copy the full SHA
    0b5cab0 View commit details
    Browse the repository at this point in the history

Commits on Nov 11, 2024

  1. Update calculations.rst 

    remove extra text
    @alhom
    alhom authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    a8e9fde View commit details
    Browse the repository at this point in the history

  2. Update miscellaneous.rst

    @alhom
    alhom authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    beebb98 View commit details
    Browse the repository at this point in the history

  3. Update plot.rst

    @alhom
    alhom authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    80a1146 View commit details
    Browse the repository at this point in the history

  4. Update plot.rst

    @alhom
    alhom authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    15c7d00 View commit details
    Browse the repository at this point in the history

  5. Update scripts.rst

    @alhom
    alhom authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    acb4884 View commit details
    Browse the repository at this point in the history

  6. Update vlsvfile.rst

    @alhom
    alhom authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    d3083b0 View commit details
    Browse the repository at this point in the history

  7. Merge pull request #6 from alhom/alhom-patch-1 

    Alhom patch 1
    @alhom
    alhom authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    6594e29 View commit details
    Browse the repository at this point in the history