Giter Club home page Giter Club logo

pythontoolboxdocumentation's Introduction

PythonToolboxDocumentation

Enables writing the Documentation for ESRI's PythonToolboxes WITHIN the PythonToolbox File (*.pyt)

Disclaimer

This is a work in progress, written by an R User.

Instructions:

Add Attributes to the Python Toolbox Class in def __init__(self). For example,

  • self.purpose
  • self.abstract
  • self.credit
  • self.tags
  • self.limits
  • self.minScale
  • self.maxScale

Enter all these attributes as characters strings except "self.tags", this must be a list of character strings.

For each Tool, you can add attributes to the parameters. E.g: param1.dialogref. For further examples see the sample toolbox.

Next, import write_docs in the beginning of your *.pyt file and run write_docs.main(Toolbox,"SampleToolbox") at the end of your *.pyt file. The second argument should contain the name of your *.pyt file without the extension.

pythontoolboxdocumentation's People

Contributors

ratnanil avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.