Merge pull request #183 from DerwenAI/update

resolve unit test for summarization #182
DerwenAI · Jul 17, 2021 · ef48ec7 · ef48ec7
2 parents 42e556b + a84581b
commit ef48ec7
Show file tree

Hide file tree

Showing 15 changed files with 479 additions and 184 deletions.
diff --git a/changelog.txt → CHANGELOG.md b/changelog.txt → CHANGELOG.md
@@ -1,9 +1,11 @@
 # PyTextRank changelog
 
-## 3.1.2
+## 3.2.0
 
-2021-07-??
+2021-07-17
 
+  * **NB: THIS SCRUBBER UPDATE WILL BREAK PREVIOUS RELEASES**
+  * allow `Span` as scrubber argument, to align with `spaCy` 3.1.x; kudos @Ankush-Chander
   * add `lgtm` code reviews (slow, not integrating into GitHub PRs directly)
   * evaluating `grayskull` to generate a conda-forge recipe
   * add use of `pipdeptree` to analyze dependencies

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,3 @@
 include README.md
-include changelog.txt
+include CHANGELOG.md
 
diff --git a/README.md b/README.md
@@ -114,7 +114,7 @@ will track with the major release number of the associated <code>spaCy</code>
 version.
 
 See:
-[changelog.txt](https://github.com/DerwenAI/pytextrank/blob/main/changelog.txt)
+[CHANGELOG.md](https://github.com/DerwenAI/pytextrank/blob/main/CHANGELOG.md)
 </details>
 
 <img

diff --git a/docs/apidocs.yml b/docs/apidocs.yml
@@ -0,0 +1,6 @@
+apidocs:
+  page: ref.md
+  template: ref.jinja
+  package: pytextrank
+  git: https://github.com/DerwenAI/pytextrank/blob/main
+  includes: BaseTextRankFactory, BaseTextRank, PositionRankFactory, PositionRank, BiasedTextRankFactory, BiasedTextRank, Lemma, Phrase, Sentence, VectorElem
diff --git a/docs/ref.jinja b/docs/ref.jinja
@@ -0,0 +1,45 @@
+# Package Reference: `{{ groups.package[0].package }}`
+{{ groups.package[0].docstring }}
+
+{% for class_name, class_item in groups.package[0].class.items() %}
+## [`{{ class_name }}` class](#{{ class_name }})
+{{ class_item.docstring | safe }}
+
+{% for method_name, method_item in class_item.method.items() %}
+---
+#### [`{{ method_name }}` method](#{{ method_item.ns_path }})
+[*\[source\]*]({{ groups.package[0].git_url }}{{ method_item.file }}#L{{ method_item.line_num }})
+
+```python
+{{ method_name }}({{ method_item.arg_list_str | safe }})
+```
+{{ method_item.docstring | safe }}
+{{ method_item.arg_docstring | safe }}
+{% endfor %}
+{% endfor %}
+
+---
+## [module functions](#{{ groups.package[0].package }}_functions)
+
+{% for func_name, func_item in groups.package[0].function.items() %}
+---
+#### [`{{ func_name }}` method](#{{ func_item.ns_path }})
+[*\[source\]*]({{ groups.package[0].git_url }}{{ func_item.file }}#L{{ func_item.line_num }})
+
+```python
+{{ func_name }}({{ func_item.arg_list_str | safe }})
+```
+{{ func_item.docstring | safe }}
+{{ func_item.arg_docstring | safe }}
+{% endfor %}
+
+---
+## [module types](#{{ groups.package[0].package }}_types)
+
+{% for type_name, type_item in groups.package[0].type.items() %}
+#### [`{{ type_name }}` type](#{{ type_item.ns_path }})
+```python
+{{ type_name }} = {{ type_item.obj | safe }}
+```
+{{ type_item.docstring | safe }}
+{% endfor %}