Commit Graph

84 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
45bb8d75a5 Fix overflow issues on small screens [ci skip] 2018-04-29 03:17:36 +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
3b0699c9fe Update benchmarks and data table style 2017-11-06 19:36:02 +01:00
ines
a9c77e01b4 Add accordion component (collapsible section) 2017-11-05 16:08:13 +01:00
ines
b53c2010db Add global focus style for links 2017-11-05 16:07:00 +01:00
ines
2940938bd8 Use more distinct style for checkboxes in quickstart 2017-11-04 14:24:30 +01:00
ines
408f450ce0 Tidy up 2017-11-01 23:01:12 +01:00
ines
e5a4c31bb4 Adjust code line height 2017-11-01 19:49:42 +01:00
ines
9b4c38fe9f Add button option to terminal component 2017-11-01 19:49:27 +01:00
ines
a6f6bd6c98 Adjust tag spacing 2017-11-01 02:04:00 +01:00
ines
38ef4274b6 Remove confusing icon for non-compatible models
ModelLoader will now output "not compatible" if no compatible version of model is found for a spaCy version
2017-10-30 14:07:42 +01:00
ines
df149455f9 Don't ever wrap navigation bar contents 2017-10-30 13:16:20 +01:00
ines
74dd0ee2c2 Prevent responsive tables form scrolling vertically 2017-10-30 13:16:06 +01:00
ines
25f6331550 Allow other style arguments on +grid-col 2017-10-30 13:15:30 +01:00
ines
47fd254ba7 Combine table scroll shadows if row has only one cell 2017-10-29 03:56:37 +01:00
ines
b11928abc2 Adjust labels, spacing and hack specificity 2017-10-29 03:56:09 +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
db15902e84 Tidy up 2017-10-23 10:38:21 +02:00
ines
bb6ecb82e5 Ensure long file paths in code examples break if needed 2017-10-14 12:51:52 +02:00
ines
4d248ea920 Fix spacing on bulleted lists 2017-10-09 14:36:30 +02:00
ines
2ac8b5c622 Add wrapper for before/after code examples 2017-10-09 14:36:20 +02:00
ines
5fb057b575 Fix secondary font stack 2017-10-03 15:45:07 +02:00
ines
3e1b971b16 Update CSS 2017-10-03 14:14:52 +02:00
ines
4731d50220 Add break utility for long nowrap items (e.g. code) 2017-08-19 12:44:23 +02:00
ines
52c6302223 Allow prompt setting on code mixin 2017-08-14 13:05:01 +02:00
ines
fd77917c5a Remove bottom padding from sidebar 2017-06-01 13:02:36 +02:00
ines
bd79e683f6 Move code block border to own modifier class 2017-05-28 16:36:42 +02:00
ines
a87da31271 Fix formatting and add subtle borders for tooltips on dark backgrounds 2017-05-21 20:51:30 +02:00
ines
5c06cf71ab Add different options for styling bash, python and divider commands 2017-05-21 20:51:17 +02:00
ines
f56cdf4ed1 Add quickstart.js note to mixin 2017-05-21 20:50:11 +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
eb3fcc7fc5 Add green theme 2017-05-20 12:57:27 +02:00
ines
8ef6bfebca Fix resetting of tooltip font 2017-05-19 20:24:32 +02:00
ines
c765e752f2 Adjust inline code colour to theme 2017-05-19 01:05:25 +02:00
ines
0f513850ab Use same colour for table foot rot and infobox 2017-05-18 22:17:41 +02:00
ines
532927a3c4 Update quickstart 2017-05-17 17:35:56 +02:00
ines
7b9466f625 Add mixins and styles for quickstart widget 2017-05-17 12:04:03 +02:00
ines
fb23799114 Add tooltips component 2017-05-17 12:04:03 +02:00
ines
326e677882 Fix syntax highlighting colour of keyword 2017-05-13 15:37:43 +02:00
ines
7f331eafcd Add SVG object 2017-05-13 03:10:41 +02:00
ines
1774cf5152 Fix light versions of colors 2017-05-12 15:57:42 +02:00
ines
7631d08d67 Adjust saturation of light theme color 2017-05-03 20:11:02 +02:00
ines
06e414b3fc Don't wrap inline code 2017-05-03 20:11:02 +02:00
ines
99558023fd Add divider table row style 2017-04-26 16:02:44 +02:00
ines
aa680e0312 Add landing badge mixin 2017-04-08 10:09:43 +02:00
ines
a9368b591a Update inline code style 2017-03-26 11:14:36 +02:00
ines
88160f5daa Update border style on infoboxes 2017-03-26 11:14:30 +02:00