Giter Club home page Giter Club logo

documentationgeneratorregistry's Introduction

DocumentationGeneratorRegistry

Build Status

This registry allows package authors to specify where to find and how to build the documentation for their packages displayed at pkg.julialang.org.

Usage

Just add a new entry to Registry.toml by hand (see Specifications below) or with the provided add_to_registry.jl script:

julia add_to_registry.jl Package1 Package2 Package3

Options

There are three options for specifying how (with the method key) and where (with the location key) to find a package's documentation:

  • vendored: The documentation source is located in a folder (specified by location) in the package's root directory.
  • git-repo: The documentation source is located in the git repo given by location.
  • hosted: The built documentation is reachable under the URL given by location.

Specifications

Each package is specified by UUID, which is also the top-level key. Required sub-keys are method, location, and name:

[uuid]
name = "PackageName"
method = "hosted"
location = "https://thisismy.hosted.documentation.org/stable"

documentationgeneratorregistry's People

Contributors

pfitzseb avatar vdayanand avatar asinghvi17 avatar davidanthoff avatar baggepinnen avatar juliohm avatar marius311 avatar mbaz avatar thofma avatar

Watchers

James Cloos avatar  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.