DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:pycode

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:pycode [2017-04-22 08:48] – [Known Bugs and Issues] torpedoplugin:pycode [2023-11-03 11:02] (current) – [PyCode Plugin] torpedo
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Plugin to embed Python script (and other) hosted in a remote repository+description: Plugin to embed Python scripts (and others) hosted in a remote repository
 author     : Torpedo author     : Torpedo
-email      : dgtorpedo@gmail.com+email      : dcstoyanov@gmail.com
 type       : syntax type       : syntax
-lastupdate : 2016-09-09+lastupdate : 2019-11-25
 compatible : 2014-09-29 "Hrun", 2015-08-10 "Detritus", 2016-06-26 "Elenor Of Tsort", 2017-02-19 "Frusterick Manners" compatible : 2014-09-29 "Hrun", 2015-08-10 "Detritus", 2016-06-26 "Elenor Of Tsort", 2017-02-19 "Frusterick Manners"
 depends    :  depends    : 
 conflicts  conflicts 
-similar    :  +similar    : repo 
-tags       : code, python, repository, syntaxhighlight+tags       : !obsolete
  
-downloadurl: https://bitbucket.org/Torpedo/pycode/get/master.zip +downloadurl: https://bitbucket.org/tormec/pycode/get/master.zip 
-bugtracker : https://bitbucket.org/Torpedo/pycode/issues?status=new&status=open +bugtracker :  
-sourcerepo : https://bitbucket.org/Torpedo/pycode/src+sourcerepo : https://bitbucket.org/tormec/pycode/src
 donationurl:  donationurl: 
  
 screenshot_img :  screenshot_img : 
 ---- ----
 +
  
 ===== Description ===== ===== Description =====
  
-PyCode is suitable to create documentation relative to your Python code. It allows you to embed **Python** script hosted in a remote public repository such as **Bitbucket** or **GitHub**.+PyCode is suitable to create documentation relative to your Python code. It allows you to embed **Python** scripts hosted in a remote public repository such as **Bitbucket** or **GitHub**.
  
 Actually PyCode allows to embeds all types of scripting language supported by GeSHi ((see [[wiki:syntax#Syntax Highlighting]])), but with some limitations. Actually PyCode allows to embeds all types of scripting language supported by GeSHi ((see [[wiki:syntax#Syntax Highlighting]])), but with some limitations.
Line 55: Line 56:
  
 and this is what you get: and this is what you get:
-{{ https://bitbucket.org/Torpedo/pycode/downloads/script.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/script.png?nolink&recache }}
 Note, at the top of the page, the notification which points out to you that, since last time you edited the page, the code in the repository has changed. Note, at the top of the page, the notification which points out to you that, since last time you edited the page, the code in the repository has changed.
  
Line 67: Line 68:
  
 and the output will be: and the output will be:
-{{ https://bitbucket.org/Torpedo/pycode/downloads/class.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/class.png?nolink&recache }}
 Each page will be created in the same namespace where this page lives. Each page will be created in the same namespace where this page lives.
  
Line 74: Line 75:
 <code><pycode https://bitbucket.org/Name/repo-test/src/master/file.py f __init__ Extra></code> <code><pycode https://bitbucket.org/Name/repo-test/src/master/file.py f __init__ Extra></code>
  
-{{ https://bitbucket.org/Torpedo/pycode/downloads/method.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/method.png?nolink&recache }}
  
 Note that we have specified from which class embed the ''%%__init__%%'' method; if we had simply written: Note that we have specified from which class embed the ''%%__init__%%'' method; if we had simply written:
Line 86: Line 87:
 In your wiki, you will warned about this changes and the embedded code will not updated until you give your consent. In your wiki, you will warned about this changes and the embedded code will not updated until you give your consent.
  
-{{ https://bitbucket.org/Torpedo/pycode/downloads/class-dif.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/class-dif.png?nolink&recache }}
  
 It's important to notice that a banner notification for a class can be flushed away in two manners: It's important to notice that a banner notification for a class can be flushed away in two manners:
Line 95: Line 96:
 ===== Installation ===== ===== Installation =====
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:plugin_installation_instructions|Plugin Installation Instructions]] on how to install plugins manually.
  
  
Line 126: Line 127:
 For default, PyCode installs a menu wizard in your toolbar. If you don't want it you can disable this option in ''Configuration Manager'' > ''Pycode''. For default, PyCode installs a menu wizard in your toolbar. If you don't want it you can disable this option in ''Configuration Manager'' > ''Pycode''.
  
-{{ https://bitbucket.org/Torpedo/pycode/downloads/wizard.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/wizard.png?nolink&recache }}
  
  
Line 143: Line 144:
 Moreover the line numbers are generated using the start and end line of the code as is in your repository. Moreover the line numbers are generated using the start and end line of the code as is in your repository.
  
-{{ https://bitbucket.org/Torpedo/pycode/downloads/method-line-numbers.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/method-line-numbers.png?nolink&recache }}
  
 Independently from the choose in the ''Configuration Manager'', it is possible to specify whether show or hide the line numbers for each singular case adding: Independently from the choose in the ''Configuration Manager'', it is possible to specify whether show or hide the line numbers for each singular case adding:
Line 161: Line 162:
 | ''src-url ⋅ class ⋅ def ⋅ #:#''  | show a title of this form where ''class'' and ''def'' are applied only for Python script and are those, if there are, specified in the syntax  | | ''src-url ⋅ class ⋅ def ⋅ #:#''  | show a title of this form where ''class'' and ''def'' are applied only for Python script and are those, if there are, specified in the syntax  |
  
-{{ https://bitbucket.org/Torpedo/pycode/downloads/method-title.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/method-title.png?nolink&recache }}
  
 Independently from the choose in the ''Configuration Manager'', it is possible to specify whether show or hide a title for the code adding: Independently from the choose in the ''Configuration Manager'', it is possible to specify whether show or hide a title for the code adding:
Line 248: Line 249:
 </code> </code>
  
-{{ https://bitbucket.org/Torpedo/pycode/downloads/class-docstr.png?nolink&recache }}+{{ https://bitbucket.org/tormec/pycode/downloads/class-docstr.png?nolink&recache }}
  
  
Line 265: Line 266:
 ---- ----
  
-**Symptom:** after plugin upgrading, PyCode doesn't update properly code out of date.+**Symptom:** PyCode doesn't update properly code out of date, even after its updating.
  
-**Possible solution:** PyCode generates a folder called ''tmp'' where it is saved a copy of the code embedded and which is used to determine how up to date is the code respect to the code hosted in the repository.+**Possible solution:** PyCode generates a folder called ''tmp'' where it saves a copy of the code embedded and which is used to determine how up to date is the code respect to the code hosted in the repository.
  
-If there was a bug, concerning how the code embedded has to be updatedit might happen that the copy of the code was badly written and PyCode can't update it.+If there was a bug, most probablythis copy has been badly written and PyCode can't update the code.
  
-Updating the plugin via ''Extension Manager'' > ''Re-install''''tmp'' folder is not deleted. +In this case, when a new fixed version of PyCode is released, it's necessary to delete the ''tmp'' folder via ''Extension Manager'' > ''Uninstall'' ''Install'' (''Re-install'' doesn't delete it).
- +
-When a new version, with the bug fixed, is released, you should ''Uninstal'' ''Install'' the plugin in order to be sure that this folder is deleted.+
  
 Bear in mind that doing this you lose track of which code is out of date. Bear in mind that doing this you lose track of which code is out of date.
----- 
- 
- 
-===== Development ===== 
- 
- 
- 
-==== Known Bugs and Issues ==== 
- 
-Please, use the relative bug tracker or write here and then I will move there.\\ --- //[[dgtorpedo@gmail.com|Torpedo]] 2015/03/23 16:16// 
- 
- 
-==== ToDo/Wish List ==== 
- 
-Let me know what do you think about this plugin and how can I improve its functionality. 
  
---- //[[dgtorpedo@gmail.com|Torpedo]] 2015/03/23 16:16// 
  
plugin/pycode.1492843685.txt.gz · Last modified: 2017-04-22 08:48 by torpedo

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki