[docs] Doc tweaks
Co-Authored-By: Lysandre Debut <lysandre.debut@reseau.eseo.fr>
This commit is contained in:
Julien ChaumondandLysandre Debut committed
1 parent
ecfddc6034
commit
fc9faa8a47
4 files changed
+37
-11
No files matched your search
+2
-2
@@ -34,11 +34,11 @@ pip install recommonmark
|
|||||||
|
|
||||||
## Building the documentation
|
## Building the documentation
|
||||||
|
|
||||||
Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the followig
|
Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the following
|
||||||
command to generate it:
|
command to generate it:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ln -s ../../examples/README.md source/examples.md
|
ln -s ../../examples/README.md examples.md
|
||||||
```
|
```
|
||||||
|
|
||||||
Once you have setup `sphinx`, you can build the documentation by running the following command in the `/docs` folder:
|
Once you have setup `sphinx`, you can build the documentation by running the following command in the `/docs` folder:
|
||||||
|
|||||||
@@ -29,4 +29,4 @@ urllib3==1.25.3
|
|||||||
sphinx-markdown-tables==0.0.9
|
sphinx-markdown-tables==0.0.9
|
||||||
numpy==1.17.2
|
numpy==1.17.2
|
||||||
tensorflow==2.0.0rc2
|
tensorflow==2.0.0rc2
|
||||||
torch==1.1.0
|
torch==1.2.0
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
function addIcon() {
|
function addIcon() {
|
||||||
const huggingFaceLogo = "http://lysand.re/huggingface_logo.svg";
|
const huggingFaceLogo = "https://huggingface.co/assets/transformers-docs/huggingface_logo.svg";
|
||||||
const image = document.createElement("img");
|
const image = document.createElement("img");
|
||||||
image.setAttribute("src", huggingFaceLogo);
|
image.setAttribute("src", huggingFaceLogo);
|
||||||
|
|
||||||
@@ -9,7 +9,7 @@ function addIcon() {
|
|||||||
div.style.paddingTop = '30px';
|
div.style.paddingTop = '30px';
|
||||||
div.style.backgroundColor = '#6670FF';
|
div.style.backgroundColor = '#6670FF';
|
||||||
|
|
||||||
const scrollDiv = document.getElementsByClassName("wy-side-scroll")[0];
|
const scrollDiv = document.querySelector(".wy-side-scroll");
|
||||||
scrollDiv.prepend(div);
|
scrollDiv.prepend(div);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -24,10 +24,10 @@ function addCustomFooter() {
|
|||||||
social.classList.add("footer__Social");
|
social.classList.add("footer__Social");
|
||||||
|
|
||||||
const imageDetails = [
|
const imageDetails = [
|
||||||
{ link: "https://huggingface.co", imageLink: "http://lysand.re/icons/website.svg" },
|
{ link: "https://huggingface.co", imageLink: "https://huggingface.co/assets/transformers-docs/website.svg" },
|
||||||
{ link: "https://twitter.com/huggingface", imageLink: "http://lysand.re/icons/twitter.svg" },
|
{ link: "https://twitter.com/huggingface", imageLink: "https://huggingface.co/assets/transformers-docs/twitter.svg" },
|
||||||
{ link: "https://github.com/huggingface", imageLink: "http://lysand.re/icons/github.svg" },
|
{ link: "https://github.com/huggingface", imageLink: "https://huggingface.co/assets/transformers-docs/github.svg" },
|
||||||
{ link: "https://www.linkedin.com/company/huggingface/", imageLink: "http://lysand.re/icons/linkedin.svg" }
|
{ link: "https://www.linkedin.com/company/huggingface/", imageLink: "https://huggingface.co/assets/transformers-docs/linkedin.svg" }
|
||||||
];
|
];
|
||||||
|
|
||||||
imageDetails.forEach(imageLinks => {
|
imageDetails.forEach(imageLinks => {
|
||||||
@@ -42,13 +42,38 @@ function addCustomFooter() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
customFooter.appendChild(social);
|
customFooter.appendChild(social);
|
||||||
document.getElementsByTagName("footer")[0].appendChild(customFooter);
|
document.querySelector("footer").appendChild(customFooter);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function addGithubButton() {
|
||||||
|
const div = `
|
||||||
|
<div class="github-repo">
|
||||||
|
<a
|
||||||
|
class="github-button"
|
||||||
|
href="https://github.com/huggingface/transformers" data-size="large" data-show-count="true" aria-label="Star huggingface/pytorch-transformers on GitHub">
|
||||||
|
Star
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
document.querySelector(".wy-side-nav-search .icon-home").insertAdjacentHTML('afterend', div);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* github-buttons v2.2.10
|
||||||
|
* (c) 2019 なつき
|
||||||
|
* @license BSD-2-Clause
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* modified to run programmatically
|
||||||
|
*/
|
||||||
|
function parseGithubButtons (){"use strict";var e=window.document,t=e.location,o=window.encodeURIComponent,r=window.decodeURIComponent,n=window.Math,a=window.HTMLElement,i=window.XMLHttpRequest,l="https://unpkg.com/github-buttons@2.2.10/dist/buttons.html",c=i&&i.prototype&&"withCredentials"in i.prototype,d=c&&a&&a.prototype.attachShadow&&!a.prototype.attachShadow.prototype,s=function(e,t,o){e.addEventListener?e.addEventListener(t,o):e.attachEvent("on"+t,o)},u=function(e,t,o){e.removeEventListener?e.removeEventListener(t,o):e.detachEvent("on"+t,o)},h=function(e,t,o){var r=function(n){return u(e,t,r),o(n)};s(e,t,r)},f=function(e,t,o){var r=function(n){if(t.test(e.readyState))return u(e,"readystatechange",r),o(n)};s(e,"readystatechange",r)},p=function(e){return function(t,o,r){var n=e.createElement(t);if(o)for(var a in o){var i=o[a];null!=i&&(null!=n[a]?n[a]=i:n.setAttribute(a,i))}if(r)for(var l=0,c=r.length;l<c;l++){var d=r[l];n.appendChild("string"==typeof d?e.createTextNode(d):d)}return n}},g=p(e),b=function(e){var t;return function(){t||(t=1,e.apply(this,arguments))}},m="body{margin:0}a{color:#24292e;text-decoration:none;outline:0}.octicon{display:inline-block;vertical-align:text-top;fill:currentColor}.widget{ display:inline-block;overflow:hidden;font-family:-apple-system, BlinkMacSystemFont, \"Segoe UI\", Helvetica, Arial, sans-serif;font-size:0;white-space:nowrap;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.btn,.social-count{display:inline-block;height:14px;padding:2px 5px;font-size:11px;font-weight:600;line-height:14px;vertical-align:bottom;cursor:pointer;border:1px solid #c5c9cc;border-radius:0.25em}.btn{background-color:#eff3f6;background-image:-webkit-linear-gradient(top, #fafbfc, #eff3f6 90%);background-image:-moz-linear-gradient(top, #fafbfc, #eff3f6 90%);background-image:linear-gradient(180deg, #fafbfc, #eff3f6 90%);background-position:-1px -1px;background-repeat:repeat-x;background-size:110% 110%;border-color:rgba(27,31,35,0.2);-ms-filter:\"progid:DXImageTransform.Microsoft.Gradient(startColorstr='#FFFAFBFC', endColorstr='#FFEEF2F5')\";*filter:progid:DXImageTransform.Microsoft.Gradient(startColorstr='#FFFAFBFC', endColorstr='#FFEEF2F5')}.btn:active{background-color:#e9ecef;background-image:none;border-color:#a5a9ac;border-color:rgba(27,31,35,0.35);box-shadow:inset 0 0.15em 0.3em rgba(27,31,35,0.15)}.btn:focus,.btn:hover{background-color:#e6ebf1;background-image:-webkit-linear-gradient(top, #f0f3f6, #e6ebf1 90%);background-image:-moz-linear-gradient(top, #f0f3f6, #e6ebf1 90%);background-image:linear-gradient(180deg, #f0f3f6, #e6ebf1 90%);border-color:#a5a9ac;border-color:rgba(27,31,35,0.35);-ms-filter:\"progid:DXImageTransform.Microsoft.Gradient(startColorstr='#FFF0F3F6', endColorstr='#FFE5EAF0')\";*filter:progid:DXImageTransform.Microsoft.Gradient(startColorstr='#FFF0F3F6', endColorstr='#FFE5EAF0')}.social-count{position:relative;margin-left:5px;background-color:#fff}.social-count:focus,.social-count:hover{color:#0366d6}.social-count b,.social-count i{position:absolute;top:50%;left:0;display:block;width:0;height:0;margin:-4px 0 0 -4px;border:solid transparent;border-width:4px 4px 4px 0;_line-height:0;_border-top-color:red !important;_border-bottom-color:red !important;_border-left-color:red !important;_filter:chroma(color=red)}.social-count b{border-right-color:#c5c9cc}.social-count i{margin-left:-3px;border-right-color:#fff}.lg .btn,.lg .social-count{height:16px;padding:5px 10px;font-size:12px;line-height:16px}.lg .social-count{margin-left:6px}.lg .social-count b,.lg .social-count i{margin:-5px 0 0 -5px;border-width:5px 5px 5px 0}.lg .social-count i{margin-left:-4px}\n",v={"mark-github":{width:16,height:16,path:'<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"/>'},eye:{width:16,height:16,path:'<path fill-rule="evenodd" d="M8.06 2C3 2 0 8 0 8s3 6 8.06 6C13 14 16 8 16 8s-3-6-7.94-6zM8 12c-2.2 0-4-1.78-4-4 0-2.2 1.8-4 4-4 2.22 0 4 1.8 4 4 0 2.22-1.78 4-4 4zm2-4c0 1.11-.89 2-2 2-1.11 0-2-.89-2-2 0-1.11.89-2 2-2 1.11 0 2 .89 2 2z"/>'},star:{width:14,height:16,path:'<path fill-rule="evenodd" d="M14 6l-4.9-.64L7 1 4.9 5.36 0 6l3.6 3.26L2.67 14 7 11.67 11.33 14l-.93-4.74L14 6z"/>'},"repo-forked":{width:10,height:16,path:'<path fill-rule="evenodd" d="M8 1a1.993 1.993 0 0 0-1 3.72V6L5 8 3 6V4.72A1.993 1.993 0 0 0 2 1a1.993 1.993 0 0 0-1 3.72V6.5l3 3v1.78A1.993 1.993 0 0 0 5 15a1.993 1.993 0 0 0 1-3.72V9.5l3-3V4.72A1.993 1.Line truncated
|
||||||
|
|
||||||
|
|
||||||
function onLoad() {
|
function onLoad() {
|
||||||
addIcon();
|
addIcon();
|
||||||
addCustomFooter();
|
addCustomFooter();
|
||||||
|
addGithubButton();
|
||||||
|
parseGithubButtons();
|
||||||
}
|
}
|
||||||
|
|
||||||
window.addEventListener("load", onLoad);
|
window.addEventListener("load", onLoad);
|
||||||
|
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
../../examples/README.md
|
||||||
Reference in new issue
Block a user