Add new API-reference page, automated generation of `.rst` files, enable `sphinx-gallery`. Fix #1808 #1809

anotherbugmaster · 2017-12-20T21:38:27Z

Reformatted API reference, but there's a little bit ugly workaround there: reference (like [1]_) doesn't work correctly if there's another reference with the same number in the upper section. I explored sklearn repo, it seems like they're aware of it and trying not to do so or making the same workaround as me.

Autosummary sphinx module

Templating

menshikh-iv

Really great change, big thanks @anotherbugmaste 💣

Of course, need to work more with structure now (missed some things), but you are on the right way!

menshikh-iv · 2017-12-21T16:00:52Z

docs/src/Makefile

@@ -32,6 +32,7 @@ help:

 clean:
 	-rm -rf $(BUILDDIR)/*
+	-rm -rf generated/*


How related $(BUILDDIR) and generated/ ?

In no way!

generated is the folder which contains new auto-generated .rst files. It ought to be purged every time documentation builds, otherwise autosummary will not update reference page.

menshikh-iv · 2017-12-21T16:27:30Z

docs/src/_templates/class.rst

@@ -0,0 +1,15 @@
+:mod:`{{module}}`.{{objname}}


Please add a link in answer, how to "form" this templates?

menshikh-iv · 2017-12-22T05:25:19Z

gensim/summarization/summarizer.py

-    """Get a list of the most important documents of a corpus using a variation of the TextRank algorithm [1]_.
-     Used as helper for summarize :func:`~gensim.summarization.summarizer.summarizer`
+    """Get a list of the most important documents of a corpus using a
+    variation of the TextRank algorithm [1].


probably, you can use text identifiers for it, for example [some-paper]

AFAIK this bug is somehow related to the trailing underscore in [reference_name]_. I'll try to find a better workaround.

@anotherbugmaster add links to comment for this PR about this bug, I'll try to find workaround too

menshikh-iv · 2017-12-22T05:36:51Z

We'll continue work on it together with @anotherbugmaster in Jan

anotherbugmaster · 2017-12-23T08:50:12Z

As for the bug message:

<autosummary>:1:Unknown target name: "1"

Here's what I've found:

https://groups.google.com/forum/#!topic/sphinx-users/JVNPh7AIKi8
Abjad/abjad#332

markroxor · 2017-12-27T05:42:17Z

@anotherbugmaster Just a generic gentle suggestion - Can you please change the title to something more informative? 😄

This reverts commit b100d86.

menshikh-iv · 2018-02-24T19:35:25Z

docs/src/Makefile


 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	rm -r $(BUILDDIR)/html/_sources
-	cp -r $(BUILDDIR)/html/* ../
+	cp -r $(BUILDDIR)/html/* .


Why this change?

My mistake, I don't like the copying to the upper level though. Why are we doing it in the first place?

menshikh-iv · 2018-02-24T19:35:58Z

docs/src/_static/js/jquery-migrate-1.1.1.min.js

@@ -1,3 +1,3 @@
-/*! jQuery Migrate v1.1.1 | (c) 2005, 2013 jQuery Foundation, Inc. and other contributors | jquery.org/license */
+/*! jQuery Migrate v1.1.1 | (c) 2005, 2013 jQuery Foundation, Inc. and other contributors | jquery.org/license */


can you simply checkout this file, please?

menshikh-iv · 2018-02-24T19:36:57Z

gensim/summarization/summarizer.py

@@ -344,6 +345,12 @@ def summarize_corpus(corpus, ratio=0.2):
    list of str
        Most important documents of given `corpus` sorted by the document score, highest first.

+    References
+    ----------
+    .. [1] Federico Barrios, Federico L´opez, Luis Argerich, Rosita Wachenchauzer (2016).


piskvorky · 2018-06-27T14:43:37Z

gensim/models/tfidfmodel.py

@@ -301,10 +301,12 @@ def __init__(self, corpus=None, id2word=None, dictionary=None, wlocal=utils.iden
            Only when `pivot` is not None will pivoted document length normalization be applied.
            Otherwise, regular TfIdf is used.
        slope : float, optional
-            Parameter required by pivoted document length normalization which determines the slope to which
-            the `old normalization` can be tilted. This parameter only works when pivot is defined.
+            It is the parameter required by pivoted document length normalization which determines the slope to which


This conflict is incorrectly resolved. Please continue with changes in #2102, which should be up-to-date with develop (plus with some additional fixes).

@piskvorky author (@anotherbugmaster) can't commit to your branch (lack of permissions)

Why not add @anotherbugmaster as a committer? I cannot commit to his fork either (that's why I created another branch, directly in gensim, so we can all collaborate).

@piskvorky done
@anotherbugmaster please fix #2102 branch (you have permissions for clone current repository (not your fork), commit & push directly to #2102 branch), sorry for bothering on vacation.

menshikh-iv · 2018-06-28T08:07:47Z

Continue in #2102

anotherbugmaster added 3 commits December 20, 2017 23:16

Reformat apiref.rst

c46cddf

Walkaround reference bug

b7e882c

Merge upstream

0092c16

anotherbugmaster added documentation Current issue related to documentation difficulty medium Medium issue: required good gensim understanding & python skills labels Dec 20, 2017

anotherbugmaster self-assigned this Dec 20, 2017

anotherbugmaster requested a review from menshikh-iv December 20, 2017 21:38

menshikh-iv reviewed Dec 21, 2017

View reviewed changes

menshikh-iv reviewed Dec 22, 2017

View reviewed changes

menshikh-iv added the incubator project PR is RaRe incubator project label Dec 26, 2017

anotherbugmaster changed the title ~~Fix 1808~~ Reformat API reference Dec 27, 2017

anotherbugmaster added 3 commits January 8, 2018 20:41

Merge upstream

3ff14b8

Workaround link bug

1d9c13f

Add 'The'

fe6b60e

menshikh-iv closed this Jan 8, 2018

menshikh-iv reopened this Jan 8, 2018

menshikh-iv closed this Jan 8, 2018

menshikh-iv reopened this Jan 8, 2018

anotherbugmaster added 5 commits January 9, 2018 19:51

Rearrange modules

0b9a135

Merge upstream

af1551b

Remove redundant "This package..."

8fa1691

Move docs/src/* -> docs/*

74dcb42

Add legacy apiref

4695125

anotherbugmaster added 5 commits February 24, 2018 15:04

Revert "Change line endings"

57c5dd3

This reverts commit b100d86.

Fix line endings (probably)

be0917e

Fix

541378e

Fix awkward docstring

b16c392

Fix references

7313d2a

menshikh-iv suggested changes Feb 24, 2018

View reviewed changes

anotherbugmaster added 3 commits February 25, 2018 14:24

Fix redundant copying of .html

a08fac9

Fix flake8

c610958

Merge remote-tracking branch 'upstream/develop' into fix_1808

f1f37d8

menshikh-iv mentioned this pull request Feb 26, 2018

Refactor documentation for gensim.models.coherencemodel. #1933

Merged

anotherbugmaster added 7 commits February 27, 2018 23:21

Add arrows and unify Workers and Dispatchers

7313808

Add example example :)

18b8b15

Add soft cosine similarity

f058879

Fix models docstring

05e9979

Fix backticks bug

2a98a19

Add C Matutils

4763459

Refine scripts reference|

7369597

menshikh-iv added the RFM label Mar 5, 2018

menshikh-iv mentioned this pull request Mar 9, 2018

Improving Tutorials #1964

Open

menshikh-iv changed the title ~~Reformat API reference~~ Add new API-reference page, automated generation of .rst files, enable sphinx-gallery. Fix #1808 Mar 9, 2018

Merge branch 'develop' into fix_1808

7a781b2

piskvorky mentioned this pull request Apr 30, 2018

Documentation fixes #2037

Open

piskvorky mentioned this pull request Jun 25, 2018

restyle API Ref #2102

Closed

anotherbugmaster added 3 commits June 27, 2018 15:53

Merge

0c63dbb

Merge

beccb35

Remove redundant rsts

aff50e9

piskvorky reviewed Jun 27, 2018

View reviewed changes

menshikh-iv closed this Jun 28, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new API-reference page, automated generation of `.rst` files, enable `sphinx-gallery`. Fix #1808 #1809

Add new API-reference page, automated generation of `.rst` files, enable `sphinx-gallery`. Fix #1808 #1809

anotherbugmaster commented Dec 20, 2017 •

edited

Loading

menshikh-iv left a comment

menshikh-iv Dec 21, 2017

anotherbugmaster Dec 22, 2017 •

edited

Loading

menshikh-iv Dec 21, 2017

anotherbugmaster Dec 22, 2017

menshikh-iv Dec 22, 2017

anotherbugmaster Dec 22, 2017 •

edited

Loading

menshikh-iv Dec 23, 2017

anotherbugmaster Dec 23, 2017

menshikh-iv commented Dec 22, 2017

anotherbugmaster commented Dec 23, 2017 •

edited

Loading

markroxor commented Dec 27, 2017

menshikh-iv Feb 24, 2018

anotherbugmaster Feb 25, 2018

menshikh-iv Feb 24, 2018

anotherbugmaster Feb 25, 2018

anotherbugmaster Feb 25, 2018

menshikh-iv Feb 24, 2018

piskvorky Jun 27, 2018 •

edited

Loading

menshikh-iv Jun 28, 2018 •

edited

Loading

piskvorky Jun 28, 2018 •

edited

Loading

menshikh-iv Jun 28, 2018 •

edited

Loading

menshikh-iv commented Jun 28, 2018

		@@ -1,3 +1,3 @@
		/! jQuery Migrate v1.1.1 \| (c) 2005, 2013 jQuery Foundation, Inc. and other contributors \| jquery.org/license /
		/! jQuery Migrate v1.1.1 \| (c) 2005, 2013 jQuery Foundation, Inc. and other contributors \| jquery.org/license /

Add new API-reference page, automated generation of .rst files, enable sphinx-gallery. Fix #1808 #1809

Add new API-reference page, automated generation of .rst files, enable sphinx-gallery. Fix #1808 #1809

Conversation

anotherbugmaster commented Dec 20, 2017 • edited Loading

menshikh-iv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anotherbugmaster Dec 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anotherbugmaster Dec 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

menshikh-iv commented Dec 22, 2017

anotherbugmaster commented Dec 23, 2017 • edited Loading

markroxor commented Dec 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

piskvorky Jun 27, 2018 • edited Loading

Choose a reason for hiding this comment

menshikh-iv Jun 28, 2018 • edited Loading

Choose a reason for hiding this comment

piskvorky Jun 28, 2018 • edited Loading

Choose a reason for hiding this comment

menshikh-iv Jun 28, 2018 • edited Loading

Choose a reason for hiding this comment

menshikh-iv commented Jun 28, 2018

Add new API-reference page, automated generation of `.rst` files, enable `sphinx-gallery`. Fix #1808 #1809

Add new API-reference page, automated generation of `.rst` files, enable `sphinx-gallery`. Fix #1808 #1809

anotherbugmaster commented Dec 20, 2017 •

edited

Loading

anotherbugmaster Dec 22, 2017 •

edited

Loading

anotherbugmaster Dec 22, 2017 •

edited

Loading

anotherbugmaster commented Dec 23, 2017 •

edited

Loading

piskvorky Jun 27, 2018 •

edited

Loading

menshikh-iv Jun 28, 2018 •

edited

Loading

piskvorky Jun 28, 2018 •

edited

Loading

menshikh-iv Jun 28, 2018 •

edited

Loading