elmau
/
zaz
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add parameter

This commit is contained in:
Mauricio Baeza 2021-02-06 21:35:07 -06:00
parent 303bd62de9
commit 2231df7427
6 changed files with 195 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
doc/build/doctrees/main/config.doctree vendored
View File

Binary file not shown.

67
doc/build/html/_sources/main/config.rst.txt vendored
View File

@ -139,4 +139,71 @@ Example:
PATH_PYGETTEXT = '/usr/lib/python3.9/Tools/i18n/pygettext.py'
Author
^^^^^^
Your information like author, one or more languages. This information is displayed in the extension manager.
**PUBLISHER**
* Dictionary
Example:
.. code-block:: python
PUBLISHER = {
'en': {'text': 'Your name', 'link': 'https://your.page'},
'es': {'text': 'Tu nombre', 'link': 'https://elmau.net'},
}
Extension icon
^^^^^^^^^^^^^^
Path relative or absolute to extension logo. Show in extension manager.
**ICON**
* String
Example:
.. code-block:: python
ICON='images/logo.png'
License
^^^^^^^
The license for your extension, please, used free license.
**LICENSE**
* String
Example:
.. code-block:: python
LICENSE_EN = f"""This file is part of {NAME}.
{NAME} is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
{NAME} is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with {NAME}. If not, see <https://www.gnu.org/licenses/>.
"""
LICENSE_ES = LICENSE_EN
.. _Semantic Versioning: https://semver.org/

60
doc/build/html/main/config.html vendored
View File

@ -165,6 +165,66 @@
</pre></div>
</div>
</div>
<div class="section" id="author">
<h3>Author<a class="headerlink" href="#author" title="Permalink to this headline"></a></h3>
<p>Your information like author, one or more languages. This information is displayed in the extension manager.</p>
<p><strong>PUBLISHER</strong></p>
<blockquote>
<div><ul class="simple">
<li><p>Dictionary</p></li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">PUBLISHER</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;text&#39;</span><span class="p">:</span> <span class="s1">&#39;Your name&#39;</span><span class="p">,</span> <span class="s1">&#39;link&#39;</span><span class="p">:</span> <span class="s1">&#39;https://your.page&#39;</span><span class="p">},</span>
<span class="s1">&#39;es&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;text&#39;</span><span class="p">:</span> <span class="s1">&#39;Tu nombre&#39;</span><span class="p">,</span> <span class="s1">&#39;link&#39;</span><span class="p">:</span> <span class="s1">&#39;https://elmau.net&#39;</span><span class="p">},</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="extension-icon">
<h3>Extension icon<a class="headerlink" href="#extension-icon" title="Permalink to this headline"></a></h3>
<p>Path relative or absolute to extension logo. Show in extension manager.</p>
<p><strong>ICON</strong></p>
<blockquote>
<div><ul class="simple">
<li><p>String</p></li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">ICON</span><span class="o">=</span><span class="s1">&#39;images/logo.png&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="license">
<h3>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h3>
<p>The license for your extension, please, used free license.</p>
<p><strong>LICENSE</strong></p>
<blockquote>
<div><ul class="simple">
<li><p>String</p></li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">LICENSE_EN</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;This file is part of </span><span class="si">{</span><span class="n">NAME</span><span class="si">}</span><span class="s2">.</span>
<span class="s2"> </span><span class="si">{</span><span class="n">NAME</span><span class="si">}</span><span class="s2"> is free software: you can redistribute it and/or modify</span>
<span class="s2"> it under the terms of the GNU General Public License as published by</span>
<span class="s2"> the Free Software Foundation, either version 3 of the License, or</span>
<span class="s2"> (at your option) any later version.</span>
<span class="s2"> </span><span class="si">{</span><span class="n">NAME</span><span class="si">}</span><span class="s2"> is distributed in the hope that it will be useful,</span>
<span class="s2"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="s2"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="s2"> GNU General Public License for more details.</span>
<span class="s2"> You should have received a copy of the GNU General Public License</span>
<span class="s2"> along with </span><span class="si">{</span><span class="n">NAME</span><span class="si">}</span><span class="s2">. If not, see &lt;https://www.gnu.org/licenses/&gt;.</span>
<span class="s2">&quot;&quot;&quot;</span>
<span class="n">LICENSE_ES</span> <span class="o">=</span> <span class="n">LICENSE_EN</span>
</pre></div>
</div>
</div>
</div>
</div>

2
doc/build/html/searchindex.js vendored
View File

@ -1 +1 @@
Search.setIndex({docnames:["index","main/config","main/intro"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","main/config.rst","main/intro.rst"],objects:{},objnames:{},objtypes:{},terms:{"2021":2,"final":2,"function":2,"new":[1,2],"true":1,The:1,With:2,absolut:1,add:2,addin:[1,2],base:1,basic:2,befor:1,bool:1,calc:[1,2],can:2,clone:2,code:1,com:[],compon:[1,2],compress:2,conf:1,configur:0,content:0,copi:2,correctli:1,cours:2,creat:[1,2],cuat:2,current:1,develop:[1,2],directori:2,domain:2,don:2,done:2,download:2,edit:1,elmau:2,exampl:1,extens:0,extensionnam:1,file:[1,2],first:0,folder:1,forget:2,from:2,gener:[1,2],git:2,gitlab:[],http:2,i18n:1,index:0,info:2,instal:0,integ:1,intern:1,introduct:0,invers:1,languag:1,lib:1,libreoffic:2,libreofric:[],local:2,look:1,macro:2,make:2,mauriciobaeza:[],modifi:1,modul:0,move:[1,2],multi:1,myfirstextens:2,myfirstextension_v0:2,mygreatextens:1,net:2,normal:1,now:2,onli:1,option:1,org:1,overview:0,oxt:2,page:0,paramet:0,path_pygettext:1,pot:[1,2],project:[1,2],python3:1,python:2,rapid:2,recomend:2,recommend:1,repositori:2,requir:0,script:2,sdk:2,search:0,semant:1,should:1,sourc:2,space:1,start:[1,2],string:1,successfulli:2,sucesfulli:2,support:2,test:2,testext:[],thi:[1,2],tool:1,type_extens:1,uniqu:1,unopkg:2,url:1,use_local:1,used:[1,2],user:2,usr:1,vim:1,want:1,you:[1,2],your:1,yournam:1,zaz:[1,2]},titles:["Welcome to ZAZ\u2019s documentation!","Configuration","Introduction"],titleterms:{"new":[],configur:1,creat:[],current:[],document:0,domain:1,extens:[1,2],first:2,indic:0,instal:2,introduct:2,local:1,name:1,overview:2,paramet:1,path:1,pygettext:1,requir:2,tabl:0,type:1,version:1,welcom:0,zaz:0}})
Search.setIndex({docnames:["index","main/config","main/intro"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","main/config.rst","main/intro.rst"],objects:{},objnames:{},objtypes:{},terms:{"2021":2,"final":2,"function":2,"new":[1,2],"public":1,"true":1,FOR:1,The:1,With:2,absolut:1,add:2,addin:[1,2],along:1,ani:1,base:1,basic:2,befor:1,bool:1,calc:[1,2],can:[1,2],clone:2,code:1,com:[],compon:[1,2],compress:2,conf:1,configur:0,content:0,copi:[1,2],correctli:1,cours:2,creat:[1,2],cuat:2,current:1,detail:1,develop:[1,2],dictionari:1,directori:2,displai:1,distribut:1,domain:2,don:2,done:2,download:2,edit:1,either:1,elmau:[1,2],even:1,exampl:1,extens:0,extensionnam:1,file:[1,2],first:0,fit:1,folder:1,forget:2,foundat:1,free:1,from:2,gener:[1,2],git:2,gitlab:[],gnu:1,have:1,hope:1,http:[1,2],i18n:1,imag:1,impli:1,index:0,info:2,inform:1,instal:0,integ:1,intern:1,introduct:0,invers:1,languag:1,later:1,lib:1,libreoffic:2,libreofric:[],license_:1,license_en:1,like:1,link:1,local:2,logo:1,look:1,macro:2,make:2,manag:1,mauriciobaeza:[],merchant:1,modifi:1,modul:0,more:1,move:[1,2],multi:1,myfirstextens:2,myfirstextension_v0:2,mygreatextens:1,net:[1,2],nombr:1,normal:1,now:2,one:1,onli:1,option:1,org:1,overview:0,oxt:2,page:[0,1],paramet:0,part:1,particular:1,path_pygettext:1,pleas:1,png:1,pot:[1,2],project:[1,2],publish:1,purpos:1,python3:1,python:2,rapid:2,receiv:1,recomend:2,recommend:1,redistribut:1,rel:1,repositori:2,requir:0,script:2,sdk:2,search:0,see:1,semant:1,should:1,show:1,softwar:1,sourc:2,space:1,start:[1,2],string:1,successfulli:2,sucesfulli:2,support:2,term:1,test:2,testext:[],text:1,thi:[1,2],tool:1,type_extens:1,under:1,uniqu:1,unopkg:2,url:1,use_local:1,used:[1,2],useful:1,user:2,usr:1,vim:1,want:1,warranti:1,without:1,www:1,you:[1,2],your:1,yournam:1,zaz:[1,2]},titles:["Welcome to ZAZ\u2019s documentation!","Configuration","Introduction"],titleterms:{"new":[],author:1,configur:1,creat:[],current:[],document:0,domain:1,extens:[1,2],first:2,icon:1,indic:0,instal:2,introduct:2,licens:1,local:1,name:1,overview:2,paramet:1,path:1,pygettext:1,requir:2,tabl:0,type:1,version:1,welcom:0,zaz:0}})

67
doc/source/main/config.rst
View File

@ -139,4 +139,71 @@ Example:
PATH_PYGETTEXT = '/usr/lib/python3.9/Tools/i18n/pygettext.py'
Author
^^^^^^
Your information like author, one or more languages. This information is displayed in the extension manager.
**PUBLISHER**
* Dictionary
Example:
.. code-block:: python
PUBLISHER = {
'en': {'text': 'Your name', 'link': 'https://your.page'},
'es': {'text': 'Tu nombre', 'link': 'https://elmau.net'},
}
Extension icon
^^^^^^^^^^^^^^
Path relative or absolute to extension logo. Show in extension manager.
**ICON**
* String
Example:
.. code-block:: python
ICON='images/logo.png'
License
^^^^^^^
The license for your extension, please, used free license.
**LICENSE**
* String
Example:
.. code-block:: python
LICENSE_EN = f"""This file is part of {NAME}.
{NAME} is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
{NAME} is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with {NAME}. If not, see <https://www.gnu.org/licenses/>.
"""
LICENSE_ES = LICENSE_EN
.. _Semantic Versioning: https://semver.org/