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

[DOCUMENTATION] Prototype documentation build glue #110

Merged
merged 31 commits into from
Sep 18, 2024
Merged

[DOCUMENTATION] Prototype documentation build glue #110

merged 31 commits into from
Sep 18, 2024

Commits on Sep 16, 2024

  1. [DOCUMENTATION] Prototype documentation features via sphinx (- WIP #79 … 

    …-)

Changes in file LICENSE.md:
 - Restyled to use markdown (Remains MIT License)
 - Added mention of modified sphinx config.py (BSD-2 License)

Changes in file Makefile:
 - Added glue code to build documentaion via sphinx. W.I.P
 - Other minor tweaks to cleanup build documentaion stuff

Changes in file docs/Makefile:
 - Added glue code to build documentaion via sphinx. W.I.P

Changes in file docs/conf.py:
 - Prototype Sphinx configuration. W.I.P.

Changes in file docs/requirements.txt:
 - Build-Docs dependencies. W.I.P.

Changes in file docs/toc.md:
 - New template Table of Contents for Multicast Documentation.
    @reactive-firewall
    reactive-firewall committed Sep 16, 2024
    1 Configuration menu
    Copy the full SHA
    dc6693f View commit details
    Browse the repository at this point in the history

  2. [DOCUMENTATION] debugged sphinx build features some more (- WIP #110 -) 

    ### ChangeLog:

Changes in file Makefile:
 cleanup:
 else
 endif

Changes in file docs/conf.py:
 Unknown Changes
    @reactive-firewall
    reactive-firewall committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    66b6457 View commit details
    Browse the repository at this point in the history

  3. [HOTFIX] Fixup .gitignore file 

    Changes in file .gitignore:
 - added some generated paths to ignore list
    @reactive-firewall
    reactive-firewall committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    afe6b2b View commit details
    Browse the repository at this point in the history

  4. [DOCUMENTATION] updated documentation configuration a bit. (- WIP #110 … 

    …-)

Changes in file docs/conf.py:
 - tweaks to theam and such
 - added project CC line
 - removed "import argparse" as per linters

Changes in file docs/toc.md:
 - tweak for less verbose navigation
    @reactive-firewall
    reactive-firewall committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    cb78e82 View commit details
    Browse the repository at this point in the history

Commits on Sep 17, 2024

  1. [DOCUMENTATION] Fixed GH links for project and updated some docs (- WIP 

    #79 & #110 -)

Changes in file LICENSE.md:
 - cleaned up markdown (still MIT License)

Changes in file docs/FAQ.md:
 - moved FAQ to its own document (- WIP #79 -)

Changes in file docs/Makefile:
 - minor tweaks for debugging the alpha

Changes in file docs/conf.py:
 - improved link resolution and such (- WIP #110 -)

Changes in file docs/toc.md:
 ## Contents:
    @reactive-firewall
    reactive-firewall committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    8242763 View commit details
    Browse the repository at this point in the history

  2. [DOCUMENTATION] Improved Documentation hopefully (- WIP #104 & #110 -) 

    Changes in file docs/CI.md:
 - Moved CI section to its own document

Changes in file docs/FAQ.md:
 - Moved FAQ to its own document

Changes in file docs/USAGE.md:
 - Moved CLI usage to a combined usage document
 - Moved alpha api usage examples to combined usage document

Changes in file docs/requirements.txt:
 - documentation generator related dependencies

Changes in file docs/toc.md:
 - improved TOC page a bit
    @reactive-firewall
    reactive-firewall committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    a645bb2 View commit details
    Browse the repository at this point in the history

  3. [REGRESSION] Apply suggestions from code review (- WIP #110 -) 

    Lots of mistakes. Lots of fixes. 🙊

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    e5a9b5a View commit details
    Browse the repository at this point in the history

  4. [DOCUMENTATION] Apply suggestions from code review (- WIP #110 -) 

    A few more fixes

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    0cefdee View commit details
    Browse the repository at this point in the history

  5. Apply suggestions from code review 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    ef3987f View commit details
    Browse the repository at this point in the history

  6. [STYLE] Apply suggestions from code review (- WIP #110 -) 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    c96e696 View commit details
    Browse the repository at this point in the history

  7. [PATCH] More Fixes 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    d70813d View commit details
    Browse the repository at this point in the history

  8. [DOCUMENTATION] CI documentation tweaks (- WIP #110 -) 

    ### ChangeLog:

Changes in file docs/CI.md:
 # CI
 ## Testing
    @reactive-firewall
    reactive-firewall committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    decc298 View commit details
    Browse the repository at this point in the history

  9. Apply MORE suggestions from code review 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    d66b9bf View commit details
    Browse the repository at this point in the history

  10. [STYLE] Refactored some unrelated code for style compliance (- WIP #53 … 

    …-)

Changes in file tests/context.py:
 * added line breaks to long lines

Changes in file tests/test_deps.py:
 * added line breaks to long lines
 * tweaked indentation

This should satisfy codecov testing failures.
* This is a trivial change and mostly unrelated to the rest of PR #110
    @reactive-firewall
    reactive-firewall committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    24f4f60 View commit details
    Browse the repository at this point in the history

  11. [DOCUMENTATION] Clearified setup the label from 'set up' the words (-… 

    … WIP #79 -)

Changes in file .circleci/config.yml:
 * Corrected 'setup' with 'set up' as needed

Changes in file .github/workflows/Tests.yml:
 * Corrected 'setup' with 'set up' as needed

Changes in file docs/FAQ.md:
 * Corrected 'setup' with 'set up' as needed

Changes in file docs/USAGE.md:
 * Corrected 'setup' with 'set up' as needed

Changes in file multicast/__init__.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file multicast/__main__.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file multicast/hear.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file multicast/recv.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file multicast/send.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file multicast/skt.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file setup.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file tests/MulticastUDPClient.py:
 * Corrected 'setup' with 'set up' as needed

Changes in file tests/context.py:
 * Corrected 'setup' with 'set up' as needed
    @reactive-firewall
    reactive-firewall committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    467473f View commit details
    Browse the repository at this point in the history

  12. [STYLE] added Copyright line to source docs (- WIP #110 -) 

    Changes in file docs/FAQ.md:
 * added copyright

Changes in file docs/USAGE.md:
 * added copyright
    @reactive-firewall
    reactive-firewall committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    50ca492 View commit details
    Browse the repository at this point in the history

  13. Update docs/USAGE.md 

    Correct for code that was refactored

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    8f12b75 View commit details
    Browse the repository at this point in the history

Commits on Sep 18, 2024

  1. [TESTING] Re-enabling test blocking for style and adding docs/require… 

    …ments.txt to CI (- WIP #110 -)

Changes in file .github/workflows/Tests.yml:
 * added documentation requirements (- WIP #53 -)

Changes in file Makefile:
 * re-enabled blocking on failure

Changes in file tox.ini:
 * added use of docs/requirements.txt
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    4a01fa5 View commit details
    Browse the repository at this point in the history

  2. [TESTING] Fixup for CI env where documentation gaps caused failures (- … 

    …FIX #110 -)

Changes in file Makefile:
 * seperated out doc dependencies into own target
 * added workaround for version already installed hanging pip

Changes in file docs/conf.py:
 * changed import logic to work around a bug that breaks CI if some doc/requirements were missing.

:tada: incoming CI stability
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    83e03d2 View commit details
    Browse the repository at this point in the history

  3. [UPGRADE] fixed spellcheck tool (- WIP #111 -) 

    Changes in file tests/check_spelling:
 * Overhauled as per #111 🎉
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    8ab47e0 View commit details
    Browse the repository at this point in the history

  4. [TESTING] fixup for CI with deepsource coverage (- WIP #110 -) 

    Changes in file .github/workflows/Tests.yml:
 * fixed a typo
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    da0a7fd View commit details
    Browse the repository at this point in the history

  5. [TESTS] used new tests/check_spelling tool to auto-fix spelling in te… 

    …st files (- WIP #110 & #111 -)

Changes in file tests/MulticastUDPClient.py:
 * corrected some spelling, should be a better read

Changes in file tests/context.py:
 * corrected some spelling, should be a better read

Changes in file tests/test_usage.py:
 * corrected some spelling, should be a better read
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    1d5900f View commit details
    Browse the repository at this point in the history

  6. [DOCUMENTATION] used new tests/check_spelling tool to fixup the docs … 

    …(- WIP #110 & #111 -)

Changes in file docs/USAGE.md:
 * corrected spelling, happy reading

Changes in file docs/conf.py:
 * corrected spelling, happy reading
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    e485acc View commit details
    Browse the repository at this point in the history

  7. [STYLE] Finished fixing with new tests/check_spelling tool (- WIP #110 … 

    …& #111 -)

Changes in file multicast/__init__.py:
 * Fixed some typos

Changes in file multicast/__main__.py:
 * Fixed some typos

Changes in file multicast/hear.py:
 * Fixed some typos

Changes in file multicast/recv.py:
 * Fixed some typos

Changes in file multicast/send.py:
 * Fixed some typos

Changes in file multicast/skt.py:
 * Fixed some typos

 * after several tests the new `tests/check_spelling` tool seems to work. Let this be the end of spelling issues in the code.
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    54e6fd2 View commit details
    Browse the repository at this point in the history

  8. [STYLE] corrected v-array to intended vary in comment (- WIP #110 -) 

    Changes in file docs/USAGE.md:
 * assuming not a v-array but the word "vary"
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    4daa0b2 View commit details
    Browse the repository at this point in the history

  9. [PATCH] Apply suggestions from code review (- WIP #110 -) 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    dacd7c0 View commit details
    Browse the repository at this point in the history

  10. [HOTFIX] fixed CI regression by false-positive spelling correction (-… 

    … WIP #110 & #111 -)

Changes in file tests/test_usage.py:
 def test_Usage_Error_WHEN_the_help_command_is_called(self):
  * should be "assertIn" the function
 def test_equivilant_response_WHEN_absolute_vs_implicit(self):
  * should be "assertIn" the function
 def test_invalid_Error_WHEN_cli_called_GIVEN_bad_input(self):
  * should be "assertIn" the function
 def test_prints_usage_WHEN_called_GIVEN_cmd_and_help_argument(self):
  * should be "assertIn" the function
 def test_prints_usage_WHEN_called_GIVEN_help_argument(self):
  * should be "assertIn" the function
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    149aa09 View commit details
    Browse the repository at this point in the history

  11. [PATCH] Apply suggestions from code review (- WIP #110 -) 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    648a3cb View commit details
    Browse the repository at this point in the history

  12. [UPDATE] Bump Version in prep of release (- WIP #110 -) 

    Changes in file multicast/__init__.py:
 * Version bump
    @reactive-firewall
    reactive-firewall committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    4d7b943 View commit details
    Browse the repository at this point in the history

  13. [STYLE] Apply suggestions from code review (- WIP #110 -) 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    85d6617 View commit details
    Browse the repository at this point in the history

  14. [PATCH] Apply suggestions from code review (- WIP #110 -) 

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
    @reactive-firewall @coderabbitai
    reactive-firewall and coderabbitai[bot] committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    a801c21 View commit details
    Browse the repository at this point in the history