Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Typedoc #2

Open
wants to merge 30 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
3ba1f5d
Start Update Work
Fancy2209 Jun 4, 2024
fc55b44
Add readme.md
Fancy2209 Jun 4, 2024
fd4b8a6
Update README.md
Fancy2209 Jun 4, 2024
eab07c4
Replace travis
Fancy2209 Jun 4, 2024
e5f96e5
Forgot the yml
Fancy2209 Jun 4, 2024
45690a5
Update package.json
Fancy2209 Jun 4, 2024
aa316c7
Merge branch 'New-Typedoc' of https://github.com/Fancy2209/docs into …
Fancy2209 Jun 4, 2024
dc8089f
yarn lock update
Fancy2209 Jun 4, 2024
9dd4008
Ugh
Fancy2209 Jun 4, 2024
e7b0d0f
No yarn for you
Fancy2209 Jun 4, 2024
dc013ba
WHERE IS TS5 COMING FROM
Fancy2209 Jun 4, 2024
d993cd2
Give up on actions
Fancy2209 Jun 4, 2024
00787fc
Typedoc Beta
Fancy2209 Jun 4, 2024
b5fbb0c
Add exclude
Fancy2209 Jun 4, 2024
52ebb2b
Remove Comments
Fancy2209 Jun 4, 2024
769af8b
Add README's to Typedoc
Fancy2209 Jun 4, 2024
6fcc57b
Remove Handlebars Theme (Handlebars is no longer used by TypeDoc)
Fancy2209 Jun 4, 2024
7d79e28
2.5 Hours Later, the option that makes the docs actually appear was o…
Fancy2209 Jun 4, 2024
5feacbf
Fix name
Fancy2209 Jun 4, 2024
2c15f71
Fix HTML
Fancy2209 Jun 4, 2024
8980f7c
Create docs.yml
Fancy2209 Jun 6, 2024
47d912f
Fix
Fancy2209 Jun 6, 2024
de18742
Actual fix
Fancy2209 Jun 6, 2024
c4f9e27
Configure Pages
Fancy2209 Jun 6, 2024
8dd0274
Update
Fancy2209 Jun 6, 2024
228c5e4
Remove branch for PR
Fancy2209 Jun 6, 2024
f8015e1
Update docs.yml
Fancy2209 Jun 6, 2024
0bc6f72
Add NPM Lock and temporary fix for Long Windows Compile Times
Fancy2209 Jun 7, 2024
06f077e
Fix Compilation and Long Compiles times on MSys2
Fancy2209 Jun 10, 2024
dcc8cdd
Use Stable Typedoc
Fancy2209 Jun 30, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs

name: Node.js CI

on:
push:
branches: [ "master" ]
repository_dispatch:
types: [ doc_build ]
workflow_dispatch:
jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Use Node.js 20
uses: actions/setup-node@v3
with:
node-version: 20
cache: 'npm'
- name: build
run: |
npm ci
npm run docs --if-present

- name: Configure Github Pages
uses: actions/configure-pages@v5

- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'bin/'
deploy:
needs: build
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

11 changes: 0 additions & 11 deletions .travis.yml

This file was deleted.

3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"typescript.tsdk": "node_modules\\typescript\\lib"
}
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,7 @@ commands each time you want to get the latest docs.

Another alternative for obtaining a local copy of the docs is to checkout the gh-pages branch, or download the zip file for the branch.

## Custom Typedoc Implementation/Theme

This uses a modified version of [Typedoc](https://github.com/TypeStrong/typedoc). However,
all modifications are done at runtime in a single file, externaly to typedoc, [https://github.com/awayjs/docs/blob/master/awaydoc.js](awaydoc.js).
This means that no typedoc code is ever altered.
Most changes are generally minor tweaks of features that typedoc doesn't support out of the box.
Other than that, this can be considered to be a custom typedoc theme.

## Feedback

Please provide any feedback in this repository. We are here to help.
Hopefully this will be a valuable resource and reference to AwayJS users.
Hopefully this will be a valuable resource and reference to AwayJS users.
121 changes: 0 additions & 121 deletions awaydoc.js

This file was deleted.

28 changes: 10 additions & 18 deletions includes/home.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,39 @@
# AwayJS API Documentation
AwayJS is composed of a series of modules which implement specific functionalities, allowing for a very flexible configuration of feature sets.

* [Modules](#anchor_modules)
* [Installation](#anchor_installation)
* [Feedback](#anchor_feedback)
* [Modules](#modules)
* [Installation](#installation)
* [Feedback](#feedback)

<a name="anchor_modules" class="anchor"></a>
## Modules

### [core](core/)
### [core](modules/_awayjs_core.html)
The root dependency for all AwayJS modules: contains basic data structures, loading mechanisms, event objects and utility functions useful for all types of rich media interface and interaction.

### [graphics](graphics/)
### [graphics](modules/_awayjs_graphics.html)
Dependency for AwayJS applications requiring graphical output: contains data structures for shapes and textures, and interface descriptions for additional APIs such as material and animator data.

### [scene](scene/)
### [scene](modules/_awayjs_scene.html)
Dependency for AwayJS applications requiring a heirarchical scenegraph: contains data structures for a collection of display object types, as well as geometric prefabs for simple 2D & 3D objects.

### [stage](stage/)
### [stage](modules/_awayjs_stage.html)
Interface for graphics module providing various outputs options to render. Contains context implementations for WebGL and Software (js) outputs, as well as a bridge option for external (native) rendering.

### [renderer](renderer/)
### [renderer](modules/_awayjs_renderer.html)
Interface for scene and material modules, providing simpified rendering for complex heriarchies.

### [materials](materials/)
### [materials](modules/_awayjs_materials.html)
Dependency for AwayJS applications requiring a configurable method for coloring / texturing / lighting the surfaces of objects: contains data structures for a collection of material types, as well as the rendering APIs (to be moved to renderer module).

### [player](player/)
Dependecy for AwayJS applications requiring scripting abstraction for different converted syntax trees such as AS2, AS3 etc.

### [view](view/)
### [view](modules/_awayjs_view.html)
Interface for scene modules, providing user interaction input / output and culling management for display objects sent to the renderer.

### [parsers](parsers/)
Temporary module to hold parsers that output classes spanning multiple modules. To be split and moved to their respective module location(s) once additional refactors are in place.

<a name="anchor_installation" class="anchor"></a>
## Installation

Please refer to the installation instructions found in
[awayjs-full](https://github.com/awayjs/awayjs-full).

<a name="anchor_feedback" class="anchor"></a>
## Feedback

Please let us know how you think this resource could be improved. We hear you!<br>
Expand Down
12 changes: 0 additions & 12 deletions lib/dummy.ts

This file was deleted.

Loading