-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
[MRG] New docs theme #2954
[MRG] New docs theme #2954
Conversation
With no opinion on any of the actual core content here, this seems like a lump of files that perhaps shouldn't be inside the open-source library source-control. The project previously had about ~850 files; this PR changes 2111 files. It includes 1300+ SVG files, 300+ JPGs, and 50+ PHP (?!?) files. But I'm not sure there's yet any actual docs (rather than just styling) in this grouping. Perhaps this belongs in some separate "website" git project? |
I'm pretty sure most of the files are not needed. @dvorakvaclav can you trim this PR down please? Let's review & commit & maintain only what we actually need. @gojomo the actual content is in the 11 HTML files (templates). Yes, this project is "just styling" – actual content is still generated dynamically from |
We deleted over 2000 unnecessary files imported from original html theme including old sphinx gensim theme. Now there should be only files, that are actually used. |
My review from Trello (sorry guys, Czech only):
Otherwise the build generation works smoothly, tested locally 👍 I have to remember to re-apply 0b12d9d when fixing the index page copy (a new commit in |
@dvorakvaclav I committed fixes & changes to the index page into https://github.com/RaRe-Technologies/gensim/tree/new_docs_theme. Please merge that into this PR first, before any further changes, to avoid git conflicts. Or give me push access to your gensim fork. |
00dc57f
to
de66bb1
Compare
I rebased & force-pushed, to remove the extra 2k files from our repo git history. |
fd54a43
to
65294ec
Compare
@gojomo @mpenkov final version here: https://radimrehurek.com/gensim_redesign/ Have a look and let me know if you see any issues – otherwise I'll merge tomorrow, the redesign is complete! Great job by @dvorakvaclav in my opinion. |
Fixes #2927.
For info, I don't know if it's only for me, but in order to generate the docs I had to remove one letter from line 1261 in
gensim/utils.py
:Yield chunks as
np.ndarrays instead of lists?
. Otherwise the doc generation process ended with the errorgensim/utils.py:docstring of gensim.utils.chunkize:9:Inline interpreted text or phrase reference start-string without end-string
. This change is not included in this PR – just the files fromdocs/src
.