Giter VIP home page Giter VIP logo

api.haxe.org's Introduction

api.haxe.org - Haxe Standard API documentation website

Build Status

This repository hosts the api.haxe.org website.

As an overview, a program in the master branch takes the documentation xml files generated by the Haxe compiler and turn them into html pages using dox.

For every commit in the development branch and tags in the haxe repo, GitHub Actions commits the xml files to the xml folder. The GitHub Actions build of this repo will then take care of generating the pages, and then deploy.

development info

To generate the pages locally, run earthly +html.

The html/css/js template files reside in the theme folder. The theme inherits dox default.

The haxelib dependencies are managed as submodules in the libs folder. We do not use lib.haxe.org just because we often evolve the dependencies in parallel to Haxe development, and it is troublesome to make proper releases...

api.haxe.org's People

Contributors

andyli avatar gama11 avatar haxe-ci avatar klabz avatar markknol avatar nadako avatar realyuniquename avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

api.haxe.org's Issues

404 for higlighter.js -- breaks version navigation

https://api.haxe.org//highlighter.js

I'm getting a 404 there:

404 Not Found

    Code: NoSuchKey
    Message: The specified key does not exist.
    Key: /highlighter.js
    RequestId: 7G3HWMZY6KMF00N7
    HostId: OrwSrzeLnjBb2joxDl4jSKubbcUB5lTaGif+OrWnSIvwVkr/Tzq7rfH3YCy8+5ciAonZeLzZYd0=

Which triggers "Loading failed for the <script> with source โ€œhttps://api.haxe.org//highlighter.jsโ€." error and breaks the top menu (can't select version there).

Notice the double / there; link seems fine with a single / ๐Ÿค”

Travis fails

I found that api.haxe.org isnt generated anymore, because there is an error.

https://travis-ci.org/github/HaxeFoundation/api.haxe.org/builds/749866906

Parsing /home/travis/build/HaxeFoundation/api.haxe.org/xml/find_file_cleanup/cs.xml
Parsing /home/travis/build/HaxeFoundation/api.haxe.org/xml/find_file_cleanup/php.xml
Error : Incompatibilities between haxe._Unserializer.FastString in cs and php (could not merge definition)
The command "neko Gen.n" exited with 255.

Tips from Slack:

Someone: Hm... I thought private API shouldn't affect doc gen
Someone else: there's an --include-private CLI flag, so private stuff may be needed. plus @:dox(show)
Another someone else: maybe import String as FastString; will do the trick? ^^

Use stable Haxe version

Can we use a stable Haxe version for generating the api docs?

Because api.haxe.org was broken yesterday because of unicode related issues in Haxe development branch.

Repo size is very huge

The repo is increasing with few mb per change on xml / theme change.

I suggest to reset history of the gh-branch on each deploy, unless there is a reason we want to keep the history.

Deployment borked

Incompatibilities between haxe._Unserializer.FastString in cs and php (could not merge definition)
looks like it's for the linux-ci-investigation branch tho, maybe we should delete that one

Error when trying to run locally

I run all commands from travis:

haxelib install all --always
haxelib dev hxparse libs/hxparse
haxelib dev hxtemplo libs/hxtemplo
haxelib dev hxargs libs/hxargs
haxelib dev markdown libs/haxe-markdown
haxelib dev dox libs/dox
haxe gen.hxml
neko Gen.n

Then I got this error:

C:\xxx\api.haxe.org>neko Gen.n run: haxe [--cwd,libs/dox,-lib,hxtemplo,-lib,hxparse,-lib,hxargs,-lib,markdown,-cp,src,-dce,no,--run,dox.Dox,-theme,C:/xxx/api.haxe.org/theme,--title,Haxe 3.2.1 API,-D,website,https://haxe.org/,-D,version,3.2.1,-D,source-path,https://github.com/HaxeFoundation/haxe/blob/3.2.1/std/,-i,C:/xxx/api.haxe.org/xml/3.2.1,-o,C:/xxx/api.haxe.org/html/v/3.2.1,-ex,microsoft,-ex,javax,-ex,cs.internal]
Type not found : dox.Dox

BTW, I think it's weird that libs/dox are empty, is that intented?

I think it might be related to the Haxe version it is using, since you do runCommand("haxe", args); in Gen? (I use Haxe 3.4.2)

No license

No license. I recommend CC-BY-SA 3.0/4.0 and CC0/MIT for code samples
For documentation, add "LICENSE" or "COPYING" file and add text of the CC-BY-SA text (for 3.0, for 4.0) or the following text:
This work (except for code samples, which are licensed under MIT/CC0 license) is licensed under the Creative Commons Attribution-ShareAlike 3.0/4.0 license. You can find copy of the CC-BY-SA here: https://creativecommons.org/licenses/by-sa/3.0/ / https://creativecommons.org/licenses/by-sa/4.0/
For code, just create "LICENSE-CODE" and add MIT/CC0 license text.

Haxe Manual is licensed under CC-BY, so it's recommended to use it instead of CC-BY-SA. Just change above links.

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.