multimark 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. multimark-0.1.3/.github/CODE_OF_CONDUCT.md +79 -0
  2. multimark-0.1.3/.github/ISSUE_TEMPLATE/bug.md +35 -0
  3. multimark-0.1.3/.github/ISSUE_TEMPLATE/feature.md +17 -0
  4. multimark-0.1.3/.github/ISSUE_TEMPLATE/question.md +15 -0
  5. multimark-0.1.3/.github/PULL_REQUEST_TEMPLATE.md +15 -0
  6. multimark-0.1.3/.github/workflows/ci.yml +121 -0
  7. multimark-0.1.3/.github/workflows/docs.yml +110 -0
  8. multimark-0.1.3/.gitignore +230 -0
  9. multimark-0.1.3/LICENSE +128 -0
  10. multimark-0.1.3/Makefile +31 -0
  11. multimark-0.1.3/PKG-INFO +148 -0
  12. multimark-0.1.3/README.md +121 -0
  13. multimark-0.1.3/assets/logo-dark.png +0 -0
  14. multimark-0.1.3/assets/logo-light.png +0 -0
  15. multimark-0.1.3/great-docs.yml +135 -0
  16. multimark-0.1.3/index.qmd +67 -0
  17. multimark-0.1.3/pyproject.toml +44 -0
  18. multimark-0.1.3/setup.cfg +4 -0
  19. multimark-0.1.3/setup.py +6 -0
  20. multimark-0.1.3/src/multimark/__init__.py +96 -0
  21. multimark-0.1.3/src/multimark/_build_cmark.py +48 -0
  22. multimark-0.1.3/src/multimark/_cmark.py +736 -0
  23. multimark-0.1.3/src/multimark/cmark.cffi.h +54 -0
  24. multimark-0.1.3/src/multimark.egg-info/PKG-INFO +148 -0
  25. multimark-0.1.3/src/multimark.egg-info/SOURCES.txt +129 -0
  26. multimark-0.1.3/src/multimark.egg-info/dependency_links.txt +1 -0
  27. multimark-0.1.3/src/multimark.egg-info/requires.txt +1 -0
  28. multimark-0.1.3/src/multimark.egg-info/top_level.txt +1 -0
  29. multimark-0.1.3/tests/conftest.py +5 -0
  30. multimark-0.1.3/tests/fixtures/extensions.txt +920 -0
  31. multimark-0.1.3/tests/fixtures/regression.txt +375 -0
  32. multimark-0.1.3/tests/fixtures/smart_punct.txt +177 -0
  33. multimark-0.1.3/tests/fixtures/spec.txt +10212 -0
  34. multimark-0.1.3/tests/spec_parser.py +100 -0
  35. multimark-0.1.3/tests/test_commonmark.py +61 -0
  36. multimark-0.1.3/tests/test_errors.py +321 -0
  37. multimark-0.1.3/tests/test_extensions.py +151 -0
  38. multimark-0.1.3/tests/test_html.py +104 -0
  39. multimark-0.1.3/tests/test_latex.py +61 -0
  40. multimark-0.1.3/tests/test_man.py +59 -0
  41. multimark-0.1.3/tests/test_package.py +49 -0
  42. multimark-0.1.3/tests/test_param_combos.py +394 -0
  43. multimark-0.1.3/tests/test_pathological.py +174 -0
  44. multimark-0.1.3/tests/test_regressions.py +209 -0
  45. multimark-0.1.3/tests/test_spec_html.py +52 -0
  46. multimark-0.1.3/tests/test_spec_renderers.py +247 -0
  47. multimark-0.1.3/tests/test_threads.py +81 -0
  48. multimark-0.1.3/tests/test_xml.py +60 -0
  49. multimark-0.1.3/third_party/cmark-gfm/extensions/CMakeLists.txt +119 -0
  50. multimark-0.1.3/third_party/cmark-gfm/extensions/autolink.c +508 -0
  51. multimark-0.1.3/third_party/cmark-gfm/extensions/autolink.h +8 -0
  52. multimark-0.1.3/third_party/cmark-gfm/extensions/cmark-gfm-core-extensions.h +54 -0
  53. multimark-0.1.3/third_party/cmark-gfm/extensions/core-extensions.c +27 -0
  54. multimark-0.1.3/third_party/cmark-gfm/extensions/ext_scanners.c +879 -0
  55. multimark-0.1.3/third_party/cmark-gfm/extensions/ext_scanners.h +24 -0
  56. multimark-0.1.3/third_party/cmark-gfm/extensions/ext_scanners.re +92 -0
  57. multimark-0.1.3/third_party/cmark-gfm/extensions/strikethrough.c +167 -0
  58. multimark-0.1.3/third_party/cmark-gfm/extensions/strikethrough.h +9 -0
  59. multimark-0.1.3/third_party/cmark-gfm/extensions/table.c +917 -0
  60. multimark-0.1.3/third_party/cmark-gfm/extensions/table.h +12 -0
  61. multimark-0.1.3/third_party/cmark-gfm/extensions/tagfilter.c +60 -0
  62. multimark-0.1.3/third_party/cmark-gfm/extensions/tagfilter.h +8 -0
  63. multimark-0.1.3/third_party/cmark-gfm/extensions/tasklist.c +156 -0
  64. multimark-0.1.3/third_party/cmark-gfm/extensions/tasklist.h +8 -0
  65. multimark-0.1.3/third_party/cmark-gfm/src/CMakeLists.txt +230 -0
  66. multimark-0.1.3/third_party/cmark-gfm/src/arena.c +104 -0
  67. multimark-0.1.3/third_party/cmark-gfm/src/blocks.c +1622 -0
  68. multimark-0.1.3/third_party/cmark-gfm/src/buffer.c +278 -0
  69. multimark-0.1.3/third_party/cmark-gfm/src/buffer.h +116 -0
  70. multimark-0.1.3/third_party/cmark-gfm/src/case_fold_switch.inc +4327 -0
  71. multimark-0.1.3/third_party/cmark-gfm/src/chunk.h +135 -0
  72. multimark-0.1.3/third_party/cmark-gfm/src/cmark-gfm-extension_api.h +737 -0
  73. multimark-0.1.3/third_party/cmark-gfm/src/cmark-gfm.h +833 -0
  74. multimark-0.1.3/third_party/cmark-gfm/src/cmark-gfm_export.h +7 -0
  75. multimark-0.1.3/third_party/cmark-gfm/src/cmark-gfm_version.h +7 -0
  76. multimark-0.1.3/third_party/cmark-gfm/src/cmark-gfm_version.h.in +7 -0
  77. multimark-0.1.3/third_party/cmark-gfm/src/cmark.c +55 -0
  78. multimark-0.1.3/third_party/cmark-gfm/src/cmark_ctype.c +44 -0
  79. multimark-0.1.3/third_party/cmark-gfm/src/cmark_ctype.h +33 -0
  80. multimark-0.1.3/third_party/cmark-gfm/src/commonmark.c +514 -0
  81. multimark-0.1.3/third_party/cmark-gfm/src/config.h +77 -0
  82. multimark-0.1.3/third_party/cmark-gfm/src/config.h.in +76 -0
  83. multimark-0.1.3/third_party/cmark-gfm/src/entities.inc +2138 -0
  84. multimark-0.1.3/third_party/cmark-gfm/src/footnotes.c +63 -0
  85. multimark-0.1.3/third_party/cmark-gfm/src/footnotes.h +27 -0
  86. multimark-0.1.3/third_party/cmark-gfm/src/houdini.h +57 -0
  87. multimark-0.1.3/third_party/cmark-gfm/src/houdini_href_e.c +100 -0
  88. multimark-0.1.3/third_party/cmark-gfm/src/houdini_html_e.c +66 -0
  89. multimark-0.1.3/third_party/cmark-gfm/src/houdini_html_u.c +149 -0
  90. multimark-0.1.3/third_party/cmark-gfm/src/html.c +502 -0
  91. multimark-0.1.3/third_party/cmark-gfm/src/html.h +27 -0
  92. multimark-0.1.3/third_party/cmark-gfm/src/inlines.c +1788 -0
  93. multimark-0.1.3/third_party/cmark-gfm/src/inlines.h +29 -0
  94. multimark-0.1.3/third_party/cmark-gfm/src/iterator.c +159 -0
  95. multimark-0.1.3/third_party/cmark-gfm/src/iterator.h +26 -0
  96. multimark-0.1.3/third_party/cmark-gfm/src/latex.c +468 -0
  97. multimark-0.1.3/third_party/cmark-gfm/src/libcmark-gfm.pc.in +10 -0
  98. multimark-0.1.3/third_party/cmark-gfm/src/linked_list.c +37 -0
  99. multimark-0.1.3/third_party/cmark-gfm/src/main.c +328 -0
  100. multimark-0.1.3/third_party/cmark-gfm/src/man.c +274 -0
  101. multimark-0.1.3/third_party/cmark-gfm/src/map.c +129 -0
  102. multimark-0.1.3/third_party/cmark-gfm/src/map.h +44 -0
  103. multimark-0.1.3/third_party/cmark-gfm/src/node.c +1045 -0
  104. multimark-0.1.3/third_party/cmark-gfm/src/node.h +167 -0
  105. multimark-0.1.3/third_party/cmark-gfm/src/parser.h +59 -0
  106. multimark-0.1.3/third_party/cmark-gfm/src/plaintext.c +218 -0
  107. multimark-0.1.3/third_party/cmark-gfm/src/plugin.c +36 -0
  108. multimark-0.1.3/third_party/cmark-gfm/src/plugin.h +34 -0
  109. multimark-0.1.3/third_party/cmark-gfm/src/references.c +43 -0
  110. multimark-0.1.3/third_party/cmark-gfm/src/references.h +26 -0
  111. multimark-0.1.3/third_party/cmark-gfm/src/registry.c +63 -0
  112. multimark-0.1.3/third_party/cmark-gfm/src/registry.h +24 -0
  113. multimark-0.1.3/third_party/cmark-gfm/src/render.c +213 -0
  114. multimark-0.1.3/third_party/cmark-gfm/src/render.h +62 -0
  115. multimark-0.1.3/third_party/cmark-gfm/src/scanners.c +14056 -0
  116. multimark-0.1.3/third_party/cmark-gfm/src/scanners.h +70 -0
  117. multimark-0.1.3/third_party/cmark-gfm/src/scanners.re +365 -0
  118. multimark-0.1.3/third_party/cmark-gfm/src/syntax_extension.c +149 -0
  119. multimark-0.1.3/third_party/cmark-gfm/src/syntax_extension.h +34 -0
  120. multimark-0.1.3/third_party/cmark-gfm/src/utf8.c +317 -0
  121. multimark-0.1.3/third_party/cmark-gfm/src/utf8.h +35 -0
  122. multimark-0.1.3/third_party/cmark-gfm/src/xml.c +182 -0
  123. multimark-0.1.3/user_guide/00-introduction.qmd +71 -0
  124. multimark-0.1.3/user_guide/01-installation.qmd +83 -0
  125. multimark-0.1.3/user_guide/02-quick-start.qmd +116 -0
  126. multimark-0.1.3/user_guide/03-gfm-extensions.qmd +168 -0
  127. multimark-0.1.3/user_guide/04-output-formats.qmd +203 -0
  128. multimark-0.1.3/user_guide/05-options-and-flags.qmd +161 -0
  129. multimark-0.1.3/user_guide/06-security.qmd +125 -0
  130. multimark-0.1.3/user_guide/07-recipes.qmd +226 -0
  131. multimark-0.1.3/user_guide/08-performance.qmd +109 -0
@@ -0,0 +1,79 @@
1
+ # Contributor Covenant 3.0 Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We pledge to make our community welcoming, safe, and equitable for all.
6
+
7
+ We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
8
+
9
+ ## Encouraged Behaviors
10
+
11
+ While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
12
+
13
+ With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
14
+
15
+ 1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
16
+ 2. Engaging **kindly and honestly** with others.
17
+ 3. Respecting **different viewpoints** and experiences.
18
+ 4. **Taking responsibility** for our actions and contributions.
19
+ 5. Gracefully giving and accepting **constructive feedback**.
20
+ 6. Committing to **repairing harm** when it occurs.
21
+ 7. Behaving in other ways that promote and sustain the **well-being of our community**.
22
+
23
+ ## Restricted Behaviors
24
+
25
+ We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
26
+
27
+ 1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
28
+ 2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
29
+ 3. **Stereotyping or discrimination.** Characterizing anyone's personality or behavior on the basis of immutable identities or traits.
30
+ 4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
31
+ 5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
32
+ 6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
33
+ 7. Behaving in other ways that **threaten the well-being** of our community.
34
+
35
+ ### Other Restrictions
36
+
37
+ 1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
38
+ 2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
39
+ 3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
40
+ 4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
41
+
42
+ ## Reporting an Issue
43
+
44
+ Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
45
+
46
+ When an incident does occur, it is important to report it promptly. To report a possible violation, please contact the project maintainer at riannone@me.com.
47
+
48
+ Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
49
+
50
+ ## Addressing and Repairing Harm
51
+
52
+ If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
53
+
54
+ 1. Warning
55
+ 1. Event: A violation involving a single incident or series of incidents.
56
+ 2. Consequence: A private, written warning from the Community Moderators.
57
+ 3. Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
58
+ 2. Temporarily Limited Activities
59
+ 1. Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
60
+ 2. Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
61
+ 3. Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
62
+ 3. Temporary Suspension
63
+ 1. Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
64
+ 2. Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
65
+ 3. Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
66
+ 4. Permanent Ban
67
+ 1. Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
68
+ 2. Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
69
+ 3. Repair: There is no possible repair in cases of this severity.
70
+
71
+ This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
72
+
73
+ ## Scope
74
+
75
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
76
+
77
+ ## Attribution
78
+
79
+ This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
@@ -0,0 +1,35 @@
1
+ ---
2
+ name: Bug
3
+ about: Something is wrong with multimark.
4
+ title: ""
5
+ labels: "Type: ☹︎ Bug"
6
+ ---
7
+
8
+ ## Prework
9
+
10
+ - [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/3/0/) and [contributing guidelines](https://github.com/rich-iannone/multimark/blob/main/.github/CONTRIBUTING.md).
11
+ - [ ] If there is [already a relevant issue](https://github.com/rich-iannone/multimark/issues), whether open or closed, comment on the existing thread instead of posting a new issue.
12
+
13
+ ## Description
14
+
15
+ Describe the bug clearly and concisely.
16
+
17
+ ## Reproducible example
18
+
19
+ - [ ] Post a minimal reproducible example (MRE) so the maintainer can troubleshoot the problems you identify. A reproducible example is:
20
+ - [ ] **Runnable**: post enough code and data so any onlooker can create the error on their own computer.
21
+ - [ ] **Minimal**: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.
22
+ - [ ] **Readable**: format your code according to the [Style Guide for Python Code](https://peps.python.org/pep-0008/).
23
+
24
+ ## Expected result
25
+
26
+ What should have happened? Please be as specific as possible.
27
+
28
+ ## Development environment
29
+
30
+ - Operating System: [e.g., Linux, macOS, Windows]
31
+ - multimark Version: [e.g., 0.1.0]
32
+
33
+ ## Additional context
34
+
35
+ Add any other context about the problem here.
@@ -0,0 +1,17 @@
1
+ ---
2
+ name: New feature
3
+ about: Suggest a new feature.
4
+ title: ""
5
+ labels: "Type: ★ Enhancement"
6
+ ---
7
+
8
+ ## Prework
9
+
10
+ - [ ] Read and abide by the multimark [code of conduct](https://www.contributor-covenant.org/version/3/0/) and [contributing guidelines](https://github.com/rich-iannone/multimark/blob/main/.github/CONTRIBUTING.md).
11
+ - [ ] Search for duplicates among the [existing issues](https://github.com/rich-iannone/multimark/issues) (both open and closed).
12
+
13
+ ## Proposal
14
+
15
+ Describe the new feature clearly and concisely. If applicable, write a minimal example in Python or in pseudo-code to show input, usage, and desired output.
16
+
17
+ To help us read any code you include (optional) please try to follow the [Style Guide for Python Code](https://peps.python.org/pep-0008/).
@@ -0,0 +1,15 @@
1
+ ---
2
+ name: Question
3
+ about: Ask a question.
4
+ title: ""
5
+ labels: "Type: ⁇ Question"
6
+ ---
7
+
8
+ ## Prework
9
+
10
+ - [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/3/0/) and [contributing guidelines](https://github.com/rich-iannone/multimark/blob/main/.github/CONTRIBUTING.md).
11
+ - [ ] If there is [already a relevant issue](https://github.com/rich-iannone/multimark/issues), whether open or closed, comment on the existing thread instead of posting a new issue.
12
+
13
+ ## Question
14
+
15
+ What would you like to know?
@@ -0,0 +1,15 @@
1
+ # Summary
2
+
3
+ Thank you for contributing to multimark! To make this process easier for
4
+ everyone, please explain the context and purpose of your contribution. Also, list
5
+ the changes made to the existing code or documentation.
6
+
7
+ # Related GitHub Issues and PRs
8
+
9
+ - Ref: #
10
+
11
+ # Checklist
12
+
13
+ - [ ] I understand and agree to the [Code of Conduct](https://www.contributor-covenant.org/version/3/0/).
14
+ - [ ] I have followed the [Style Guide for Python Code](https://peps.python.org/pep-0008/) as best as possible for the submitted code.
15
+ - [ ] I have added **pytest** unit tests for any new functionality.
@@ -0,0 +1,121 @@
1
+ name: Build and Test
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+ release:
9
+ types: [published]
10
+
11
+ env:
12
+ FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
13
+
14
+ jobs:
15
+ test:
16
+ name: Test on ${{ matrix.os }} / Python ${{ matrix.python-version }}
17
+ runs-on: ${{ matrix.os }}
18
+ strategy:
19
+ fail-fast: false
20
+ matrix:
21
+ os: [ubuntu-latest, macos-latest, windows-latest]
22
+ python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
23
+
24
+ steps:
25
+ - uses: actions/checkout@v6
26
+ with:
27
+ fetch-depth: 0
28
+
29
+ - uses: actions/setup-python@v6
30
+ with:
31
+ python-version: ${{ matrix.python-version }}
32
+
33
+ - name: Install package and test dependencies
34
+ run: |
35
+ pip install -e ".[dev]" || pip install -e .
36
+ pip install pytest
37
+
38
+ - name: Run tests
39
+ run: pytest tests/ -v
40
+
41
+ build_wheels:
42
+ name: Build wheels on ${{ matrix.os }}
43
+ runs-on: ${{ matrix.os }}
44
+ needs: test
45
+ if: github.event_name == 'release'
46
+ strategy:
47
+ matrix:
48
+ os: [ubuntu-latest, macos-latest, windows-latest]
49
+
50
+ steps:
51
+ - uses: actions/checkout@v4
52
+ with:
53
+ fetch-depth: 0
54
+
55
+ - uses: actions/setup-python@v5
56
+ with:
57
+ python-version: "3.12"
58
+
59
+ - name: Install cibuildwheel
60
+ run: pip install cibuildwheel==2.21.0
61
+
62
+ - name: Build wheels
63
+ run: python -m cibuildwheel --output-dir wheelhouse
64
+ env:
65
+ CIBW_BUILD: "cp39-* cp310-* cp311-* cp312-* cp313-*"
66
+ CIBW_SKIP: "*-win32 *-manylinux_i686 *-musllinux_i686"
67
+ CIBW_ARCHS_MACOS: "x86_64 arm64"
68
+ CIBW_ARCHS_LINUX: "x86_64"
69
+ CIBW_BEFORE_BUILD: "git config --global --add safe.directory /project"
70
+ CIBW_TEST_COMMAND: "pytest {project}/tests -x"
71
+ CIBW_TEST_REQUIRES: "pytest"
72
+
73
+ - uses: actions/upload-artifact@v4
74
+ with:
75
+ name: wheels-${{ matrix.os }}
76
+ path: ./wheelhouse/*.whl
77
+
78
+ build_sdist:
79
+ name: Build source distribution
80
+ runs-on: ubuntu-latest
81
+ needs: test
82
+ if: github.event_name == 'release'
83
+
84
+ steps:
85
+ - uses: actions/checkout@v4
86
+ with:
87
+ fetch-depth: 0
88
+
89
+ - uses: actions/setup-python@v5
90
+ with:
91
+ python-version: "3.12"
92
+
93
+ - name: Build sdist
94
+ run: pip install build && python -m build --sdist
95
+
96
+ - uses: actions/upload-artifact@v4
97
+ with:
98
+ name: sdist
99
+ path: dist/*.tar.gz
100
+
101
+ publish:
102
+ name: Publish to PyPI
103
+ needs: [build_wheels, build_sdist]
104
+ runs-on: ubuntu-latest
105
+ if: github.event_name == 'release'
106
+ steps:
107
+ - uses: actions/download-artifact@v4
108
+ with:
109
+ pattern: wheels-*
110
+ path: dist
111
+ merge-multiple: true
112
+
113
+ - uses: actions/download-artifact@v4
114
+ with:
115
+ name: sdist
116
+ path: dist
117
+
118
+ - uses: pypa/gh-action-pypi-publish@release/v1
119
+ with:
120
+ user: __token__
121
+ password: ${{ secrets.PYPI_API_TOKEN }}
@@ -0,0 +1,110 @@
1
+ name: CI Docs
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+ pull_request:
8
+
9
+ jobs:
10
+ build-docs:
11
+ name: "Build Docs"
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@v6
15
+ with:
16
+ fetch-depth: 0 # Full history for accurate page timestamps
17
+
18
+ - uses: actions/setup-python@v6
19
+ with:
20
+ python-version: "3.11"
21
+
22
+ - name: Install package and dependencies
23
+ run: |
24
+ python -m pip install --upgrade pip
25
+ python -m pip install -e .
26
+ python -m pip install great-docs
27
+
28
+ - name: Set up Quarto
29
+ uses: quarto-dev/quarto-actions/setup@v2
30
+
31
+ - name: Build docs
32
+ run: great-docs build
33
+
34
+ - name: Save docs artifact
35
+ uses: actions/upload-artifact@v7
36
+ with:
37
+ name: docs-html
38
+ path: great-docs/_site
39
+ include-hidden-files: true
40
+
41
+ - name: Upload build timings
42
+ uses: actions/upload-artifact@v7
43
+ with:
44
+ name: build-timings
45
+ path: great-docs/_site/build-timings.json
46
+
47
+ publish-docs:
48
+ name: "Publish Docs"
49
+ runs-on: ubuntu-latest
50
+ needs: "build-docs"
51
+ if: github.ref == 'refs/heads/main'
52
+ permissions:
53
+ pages: write
54
+ id-token: write
55
+ environment:
56
+ name: github-pages
57
+ url: ${{ steps.deployment.outputs.page_url }}
58
+ steps:
59
+ - uses: actions/download-artifact@v7
60
+ with:
61
+ name: docs-html
62
+ path: great-docs/_site
63
+
64
+ - name: Upload Pages artifact
65
+ uses: actions/upload-pages-artifact@v5
66
+ with:
67
+ path: great-docs/_site
68
+ include-hidden-files: true
69
+
70
+ - name: Deploy to GitHub Pages
71
+ id: deployment
72
+ uses: actions/deploy-pages@v5
73
+
74
+ preview-docs:
75
+ name: "Preview Docs"
76
+ runs-on: ubuntu-latest
77
+ needs: "build-docs"
78
+ if: github.event_name == 'pull_request'
79
+ permissions:
80
+ deployments: write
81
+ pull-requests: write
82
+ steps:
83
+ - uses: actions/download-artifact@v7
84
+ with:
85
+ name: docs-html
86
+ path: great-docs/_site
87
+
88
+ # Start deployment
89
+ - name: Configure pull release name
90
+ if: ${{ github.event_name == 'pull_request' }}
91
+ run: |
92
+ echo "RELEASE_NAME=pr-${{ github.event.number }}" >> $GITHUB_ENV
93
+
94
+ - name: Configure branch release name
95
+ if: ${{ github.event_name != 'pull_request' }}
96
+ run: |
97
+ # use branch name, but replace slashes. E.g. feat/a -> feat-a
98
+ echo "RELEASE_NAME=${GITHUB_REF_NAME//\//-}" >> $GITHUB_ENV
99
+
100
+ # Deploy
101
+ - name: Create Github Deployment
102
+ uses: bobheadxi/deployments@v1
103
+ id: deployment
104
+ if: ${{ !github.event.pull_request.head.repo.fork }}
105
+ with:
106
+ step: start
107
+ token: ${{ secrets.GITHUB_TOKEN }}
108
+ env: ${{ env.RELEASE_NAME }}
109
+ ref: ${{ github.head_ref }}
110
+ logs: "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
@@ -0,0 +1,230 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ # Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ # poetry.lock
109
+ # poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ # pdm.lock
116
+ # pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ # pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # Redis
135
+ *.rdb
136
+ *.aof
137
+ *.pid
138
+
139
+ # RabbitMQ
140
+ mnesia/
141
+ rabbitmq/
142
+ rabbitmq-data/
143
+
144
+ # ActiveMQ
145
+ activemq-data/
146
+
147
+ # SageMath parsed files
148
+ *.sage.py
149
+
150
+ # Environments
151
+ .env
152
+ .envrc
153
+ .venv
154
+ env/
155
+ venv/
156
+ ENV/
157
+ env.bak/
158
+ venv.bak/
159
+
160
+ # Spyder project settings
161
+ .spyderproject
162
+ .spyproject
163
+
164
+ # Rope project settings
165
+ .ropeproject
166
+
167
+ # mkdocs documentation
168
+ /site
169
+
170
+ # mypy
171
+ .mypy_cache/
172
+ .dmypy.json
173
+ dmypy.json
174
+
175
+ # Pyre type checker
176
+ .pyre/
177
+
178
+ # pytype static type analyzer
179
+ .pytype/
180
+
181
+ # Cython debug symbols
182
+ cython_debug/
183
+
184
+ # PyCharm
185
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
186
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
187
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
188
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
189
+ # .idea/
190
+
191
+ # Abstra
192
+ # Abstra is an AI-powered process automation framework.
193
+ # Ignore directories containing user credentials, local state, and settings.
194
+ # Learn more at https://abstra.io/docs
195
+ .abstra/
196
+
197
+ # Visual Studio Code
198
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
199
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
200
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
201
+ # you could uncomment the following to ignore the entire vscode folder
202
+ # .vscode/
203
+ # Temporary file for partial code execution
204
+ tempCodeRunnerFile.py
205
+
206
+ # Ruff stuff:
207
+ .ruff_cache/
208
+
209
+ # PyPI configuration file
210
+ .pypirc
211
+
212
+ # Marimo
213
+ marimo/_static/
214
+ marimo/_lsp/
215
+ __marimo__/
216
+
217
+ # Streamlit
218
+ .streamlit/secrets.toml
219
+ CMARK.md
220
+
221
+ # Claude Code
222
+ .claude/
223
+
224
+ # Great Docs build directory (ephemeral, do not commit)
225
+ great-docs/
226
+
227
+ # Great Docs versioned-build artifacts
228
+ .great-docs-build/
229
+ .great-docs-cache/
230
+ .great-docs/