Commit Graph

59 Commits

Author SHA1 Message Date
Ines Montani
968f6f0bda
💫 Document Cython API (#2433)
## Description

This PR adds the most relevant documentation of spaCy's Cython API.

(Todo for when we publish this: rewrite `/api/#section-cython` and `/api/#cython` to `/api/cython#conventions`.)

### Types of change
docs

## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-06-11 17:47:46 +02:00
ines
6efb4cdf88 Use Juniper and tidy up 2018-04-30 18:48:35 +02:00
Ines Montani
49cee4af92
💫 Interactive code examples, spaCy Universe and various docs improvements (#2274)
* Integrate Python kernel via Binder

* Add live model test for languages with examples

* Update docs and code examples

* Adjust margin (if not bootstrapped)

* Add binder version to global config

* Update terminal and executable code mixins

* Pass attributes through infobox and section

* Hide v-cloak

* Fix example

* Take out model comparison for now

* Add meta text for compat

* Remove chart.js dependency

* Tidy up and simplify JS and port big components over to Vue

* Remove chartjs example

* Add Twitter icon

* Add purple stylesheet option

* Add utility for hand cursor (special cases only)

* Add transition classes

* Add small option for section

* Add thumb object for small round thumbnail images

* Allow unset code block language via "none" value

(workaround to still allow unset language to default to DEFAULT_SYNTAX)

* Pass through attributes

* Add syntax highlighting definitions for Julia, R and Docker

* Add website icon

* Remove user survey from navigation

* Don't hide GitHub icon on small screens

* Make top navigation scrollable on small screens

* Remove old resources page and references to it

* Add Universe

* Add helper functions for better page URL and title

* Update site description

* Increment versions

* Update preview images

* Update mentions of resources

* Fix image

* Fix social images

* Fix problem with cover sizing and floats

* Add divider and move badges into heading

* Add docstrings

* Reference converting section

* Add section on converting word vectors

* Move converting section to custom section and fix formatting

* Remove old fastText example

* Move extensions content to own section

Keep weird ID to not break permalinks for now (we don't want to rewrite URLs if not absolutely necessary)

* Use better component example and add factories section

* Add note on larger model

* Use better example for non-vector

* Remove similarity in context section

Only works via small models with tensors so has always been kind of confusing

* Add note on init-model command

* Fix lightning tour examples and make excutable if possible

* Add spacy train CLI section to train

* Fix formatting and add video

* Fix formatting

* Fix textcat example description (resolves #2246)

* Add dummy file to try resolve conflict

* Delete dummy file

* Tidy up [ci skip]

* Ensure sufficient height of loading container

* Add loading animation to universe

* Update Thebelab build and use better startup message

* Fix asset versioning

* Fix typo [ci skip]

* Add note on project idea label
2018-04-29 02:06:46 +02:00
ines
b3e502a076 Add videos section to resources 2017-11-13 08:29:57 +01:00
ines
2229aba71c Update website 2017-11-08 01:06:30 +01:00
ines
1768703e1c Update website for v2.0 2017-11-07 14:48:17 +01:00
ines
ad6438ccdf Update aside labels and under construction mixin 2017-11-07 00:23:00 +01:00
ines
71852d3f25 Fix code mixins 2017-11-06 20:16:19 +01:00
ines
3b0699c9fe Update benchmarks and data table style 2017-11-06 19:36:02 +01:00
ines
64d0f97c67 Update benchmarks and models 2017-11-06 18:19:00 +01:00
ines
a6ffa942bb Update UD schemes 2017-11-05 18:46:24 +01:00
ines
e7d0641125 Update POS row mixins 2017-11-05 18:16:16 +01:00
ines
a9c77e01b4 Add accordion component (collapsible section) 2017-11-05 16:08:13 +01:00
ines
9b4c38fe9f Add button option to terminal component 2017-11-01 19:49:27 +01:00
ines
14ad92d337 Ensure fallbacks / progressive enhancement if JS disabled 2017-10-30 16:16:19 +01:00
ines
25f6331550 Allow other style arguments on +grid-col 2017-10-30 13:15:30 +01:00
ines
08869c19fd Merge mixins and mixins-base
The distinction was never clear anyways and it was progressively getting messier. So all mixins live in one file now.
2017-10-30 13:15:13 +01:00
ines
53bfcdba31 Make tooltips/tags and old/new code blocks more accessible (see #(see #1471))
Always add tooltip text as hidden label. Use different tooltip icons for tags and inline help icons. Add labels to old/new code blocks and add option to customise label text.
2017-10-29 01:17:49 +02:00
ines
52f1bf2729 Adjust GitHub embeds 2017-10-27 12:30:59 +02:00
ines
6686e53530 Allow GitHub embeds to specify optional language 2017-10-24 16:00:56 +02:00
ines
bb6ecb82e5 Ensure long file paths in code examples break if needed 2017-10-14 12:51:52 +02:00
ines
b4fc6b203c Rename mixin 2017-10-10 04:22:23 +02:00
ines
2ac8b5c622 Add wrapper for before/after code examples 2017-10-09 14:36:20 +02:00
ines
9af604f0da Update layout templates, partials and mixins 2017-10-03 14:20:13 +02:00
ines
52c6302223 Allow prompt setting on code mixin 2017-08-14 13:05:01 +02:00
ines
ec6d2bc81d Add table of contents mixin 2017-06-03 22:16:26 +02:00
ines
9064fbbf1e Fix empty arguments in mixins 2017-06-01 18:57:02 +02:00
ines
bea6e6bfad Allow annotation row to take children 2017-06-01 11:51:14 +02:00
ines
189db308d9 Only add coloured border to code block if icon has colour 2017-05-28 16:36:21 +02:00
ines
ea9474f71c Add version tag mixin to label new features 2017-05-26 12:42:36 +02:00
ines
00ede349dc Add table row for linguistic annotations 2017-05-23 23:13:37 +02:00
ines
7e5163402e Allow clipping code block to height and add docs 2017-05-23 23:13:26 +02:00
ines
869dbf92ce Add option for code blocks with (colored) icons
Plus "old" / "new" style with green accept / red reject icon
2017-05-21 13:22:34 +02:00
ines
b53ed82f0f Fix +tag-model mixin to check for length of spread arguments 2017-05-21 01:12:30 +02:00
ines
4587fdf3c9 Set API mixin to nowrap to not break between text and icon 2017-05-20 12:57:46 +02:00
ines
ce095fdcde Add +tag-model mixin to label functionality that requires model
Usage: +tag-model("vectors")
2017-05-19 20:24:17 +02:00
ines
89f850eafa Use coloured icons for +api and +src 2017-05-19 01:05:16 +02:00
ines
95307d1e3c Add mixin to display help icon with tooltip 2017-05-17 12:04:03 +02:00
ines
2e4db1beb9 Fix formatting 2017-05-13 12:02:39 +02:00
ines
d5c83a5810 Fix image mixin to allow figure with no args 2017-05-13 03:10:35 +02:00
ines
41c6085a6c Add pos-row and dep-row mixins to global mixins 2017-05-03 20:11:02 +02:00
ines
5a470367df Add mixin for model row in model docs 2017-04-26 16:03:17 +02:00
ines
6c4f3c6fc2 Allow styles arguments on row mixin 2017-04-26 16:02:59 +02:00
ines
3e3f20e68b Add infobox mixin 2017-03-16 21:53:15 +01:00
Ines Montani
614f95f3bf Remove help cursor from API links 2017-01-02 00:29:08 +01:00
Ines Montani
f6f6e028ea Make links detect target automatically and replace false with null for no attribute
New version of Harp would render attribute=false as attribute="false",
while attribute=null renders element without attribute.
2016-12-24 12:24:04 +01:00
Ines Montani
11ec02d5e3 Separate inline icon and help cursor classes 2016-12-23 14:36:03 +01:00
Ines Montani
ac95779a75 Wrap src mixin in nowrap to prevent line break between text and icon 2016-12-18 17:41:03 +01:00
Ines Montani
ce8bf08223 Fix formatting 2016-12-18 17:40:20 +01:00
Ines Montani
bf65d070ef Add CodePen embed mixin 2016-11-25 02:30:31 +01:00