GithubHelp home page GithubHelp logo
fbhaddock

facebook / fbhaddock Goto Github PK

View Code? Open in 1sVSCode Editor NEW

This project forked from haskell/haddock

6.0 5.0 10.0 14.57 MB

Haskell Documentation Tool

Home Page: www.haskell.org/haddock/

License: Other

Makefile 0.24% Haskell 43.77% CSS 2.18% JavaScript 0.41% TypeScript 1.53% TeX 0.35% Shell 0.21% HTML 51.32%

fbhaddock's Introduction

Haddock, a Haskell Documentation Tool Build Status

About haddock

See Description on Hackage.

Source code documentation

Full documentation can be found in the doc/ subdirectory, in reStructedText format format.

Project overview

This project consists of three packages:

  • haddock
  • haddock-api
  • haddock-library

haddock

The haddock package provides the haddock executable. It is implemented as a tiny wrapper around haddock-api's Documentation.Haddock.haddock function.

haddock-api

haddock-api contains the program logic of the haddock tool. The haddocks for the Documentation.Haddock module offer a good overview of haddock-api's functionality.

haddock-library

haddock-library is concerned with the parsing and processing of the Haddock markup language.

Contributing

Please create issues when you have any problems and pull requests if you have some code.

Hacking

To get started you'll need a latest GHC release installed.

Clone the repository:

  git clone https://github.com/haskell/haddock.git
  cd haddock

and then proceed using your favourite build tool.

Using cabal new-build

cabal new-build -w ghc-8.4.1
# build & run the test suite
cabal new-test -w ghc-8.4.1 all

Using Cabal sandboxes

cabal sandbox init
cabal sandbox add-source haddock-library
cabal sandbox add-source haddock-api
cabal sandbox add-source haddock-test
# adjust -j to the number of cores you want to use
cabal install -j4 --dependencies-only --enable-tests
cabal configure --enable-tests
cabal build -j4
# run the test suite
export HADDOCK_PATH="dist/build/haddock/haddock"
cabal test

Using Stack

stack init
stack install
# run the test suite
export HADDOCK_PATH="$HOME/.local/bin/haddock"
stack test

Git Branches

If you're a GHC developer and want to update Haddock to work with your changes, you should be working on ghc-head branch. See instructions at https://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git/Submodules for an example workflow.

Updating html-test

When accepting any changes in the output of html-test, it is important to use the --haddock-path option. For example:

cabal new-run -- html-test --haddock-path $(find dist-newstyle/ -executable -type f -name haddock) --accept

fbhaddock's People

Contributors

waern avatar panhania avatar sol avatar Fuuzetsu avatar mzero avatar alexbiehl avatar bgamari avatar igfoo avatar hvr avatar ezyang avatar alanz avatar harpocrates avatar haasn avatar simonmar avatar RyanGlScott avatar sjakobi avatar nominolo avatar Helkafen avatar batterseapower avatar gergoerdi avatar phadej avatar Rufflewind avatar thoughtpolice avatar thielema avatar idontgetoutmuch avatar adamse avatar luite avatar mpickering avatar JPMoresmau avatar duog avatar

Stargazers

Keany Vy KHUN avatar @GOUAIC avatar lilkypimp1 avatar ChrisQIU avatar Gábor Mihálcz avatar Arun Kumar avatar

Watchers

Killian Murphy avatar  avatar James Cloos avatar Zejun Wu avatar Last G 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.