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

Create sphinx documentation for simplify, join, insert, and powerset #8

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Create sphinx documentation for simplify, join, insert, and powerset #8

wants to merge 15 commits into from

Commits on Aug 16, 2024

  1. Tidied documentation for simplify. Created documentation for join, in… 

    …sert, and powerset. Still need function name changes and examples.
    @hmhummel
    hmhummel committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    00d4aee View commit details
    Browse the repository at this point in the history

  2. Rectified changes with function names in simplify documentation

    @hmhummel
    hmhummel committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    16814e2 View commit details
    Browse the repository at this point in the history

  3. Completed causaleffect to y0 function name changes for join. Still ne… 

    …eds unit test/example
    @hmhummel
    hmhummel committed Aug 16, 2024
    Configuration menu
    Copy the full SHA
    2480301 View commit details
    Browse the repository at this point in the history

Commits on Aug 19, 2024

  1. Ignored .DS_Store files

    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    511a17b View commit details
    Browse the repository at this point in the history

  2. Replaced capital letter parameters with more descriptive variable nam… 

    …es, and described equivalency of each parametery to `causaleffect` functions. Added more detail to parameter documentation to increase clarity.
    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    f285cdb View commit details
    Browse the repository at this point in the history

  3. Added :math: before relevant formulas

    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    ab686d1 View commit details
    Browse the repository at this point in the history

  4. Replaced capital letter parameters in insert with more descriptive … 

    …variable names, and described equivalency of each parameter to `causaleffect` functions. Added more detail to parameter documentation to increase clarity.
    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    5d8766c View commit details
    Browse the repository at this point in the history

  5. Changed formatting in simplify documentation

    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    3183253 View commit details
    Browse the repository at this point in the history

  6. Replaced capital letter parameters with more descriptive variable nam… 

    …es in `simplify` documentation.
    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    b16ceb4 View commit details
    Browse the repository at this point in the history

  7. Added causaleffect package as a reference on main page of documenta… 

    …tion
    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    11d2be9 View commit details
    Browse the repository at this point in the history

  8. Made formatting changes to powerset documentation

    @hmhummel
    hmhummel committed Aug 19, 2024
    Configuration menu
    Copy the full SHA
    01dd8c5 View commit details
    Browse the repository at this point in the history

Commits on Aug 20, 2024

  1. Created unit_tests directory and a Jupyter notebook for `test_case_… 

    …1` to begin writing unit tests
    @hmhummel
    hmhummel committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    769c22d View commit details
    Browse the repository at this point in the history

  2. Added setup code for test_case_1

    @hmhummel
    hmhummel committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    0d52402 View commit details
    Browse the repository at this point in the history

Commits on Aug 21, 2024

  1. Ran sphinx-quickstart to create html files for causaleffectpy doc… 

    …umentation
    @hmhummel
    hmhummel committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    c650c33 View commit details
    Browse the repository at this point in the history

  2. Added prettier theme to sphinx documentation

    @hmhummel
    hmhummel committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    d274360 View commit details
    Browse the repository at this point in the history