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.

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

Feature/summer2024 #34

Merged
merged 61 commits into from
Sep 2, 2024
Merged

Feature/summer2024 #34

merged 61 commits into from
Sep 2, 2024

Conversation

anbeemer
Copy link
Collaborator

Updated unit tests:

  • Added tests
  • Rewrote using pytest

Refactor of code to be less monolithic.

Created documentation.

ofloveandhate and others added 30 commits July 11, 2024 16:35
some of the content went into various rst files in `docs/`
in the github action for building documentation, i got this:

```
Configuration error:
There is a programmable error in your configuration file:
Traceback (most recent call last):
  File "/usr/local/lib/python3.8/site-packages/sphinx/config.py", line 348, in eval_config_file
    execfile_(filename, namespace)
  File "/usr/local/lib/python3.8/site-packages/sphinx/util/pycompat.py", line 81, in execfile_
    exec(code, _globals)
  File "/github/workspace/docs/conf.py", line 42, in <module>
    import markdown2canvas
  File "/github/workspace/markdown2canvas/__init__.py", line 10, in <module>
    logging.basicConfig(encoding='utf-8')
  File "/usr/local/lib/python3.8/logging/__init__.py", line 1997, in basicConfig
    raise ValueError('Unrecognised argument(s): %s' % keys)
ValueError: Unrecognised argument(s): encoding
make: *** [Makefile:20: html] Error 2
```
i don't think it was doing anything
namespace is so much cleaner.

added module level docstrings

docstrings for most functions added

all unit tests passed
Takes into account that there may be multiple instances of a given file in different folders if meta.json was changed and the previous instances were not deleted.
anbeemer and others added 27 commits July 19, 2024 10:13
page is published before checking contents; style removed from generic style test to check default.
to make more clear that setting them does nothing.  you have to call functions using them!
module namespaces are still clogged with things like `os` -- for example, `mc.canvas_objects.os`.  The `os` there shouldn't make it out.  But I'm running out of time to work on this.
Was using datetime, which caused a problem running in the evening (central). Didn't think the test was worth the trouble.
now provides defaults OUTSIDE the function, and the extensions are customizable via the defaults.json file

they are NOT over-rideable per-object, though
also, adding references to other content, to touched `conf.py`
@ofloveandhate ofloveandhate merged commit efd2487 into main Sep 2, 2024
1 check passed
@ofloveandhate
Copy link
Owner

Completed.

This should trigger a doc build for the Main version of the code, significantly improving the online documentation

@ofloveandhate ofloveandhate deleted the feature/summer2024 branch September 2, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants