Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
5dd7481
updating README and gitignore for Python
SuperFola Jul 18, 2021
73cb423
setting up base Python project
SuperFola Jul 18, 2021
8ae5a9b
adding GitHub action linter
SuperFola Jul 18, 2021
b428e84
merging with master
SuperFola Jul 18, 2021
1c6b4d2
adding a virtual environment
SuperFola Jul 18, 2021
c726807
adding a basic logger
SuperFola Jul 18, 2021
235b7ca
adding argument [source_folder]
SuperFola Jul 18, 2021
96c8c89
adding a very basic WIP parser
SuperFola Jul 18, 2021
927adb3
renaming logger.py to logger_utils.py
SuperFola Jul 18, 2021
c82dd39
adding a file explorer and reader
SuperFola Jul 18, 2021
d62c170
adding a generator module plus the specification
SuperFola Jul 18, 2021
395f59f
enhancing generator and adding basic WIP template
SuperFola Jul 18, 2021
14cddc0
updating python requirements
SuperFola Jul 18, 2021
3b203b3
adding more files for the templates
SuperFola Jul 18, 2021
bb981a6
enhancing the parser's tokenizer
SuperFola Jul 18, 2021
3ac4796
fixing parser and better tokenizer
SuperFola Jul 18, 2021
c6bdd30
cleaning the parser code and adding a documentation extractor
SuperFola Jul 18, 2021
f7a4aa7
adding documentation extraction
SuperFola Jul 18, 2021
6edec06
removing debug code
SuperFola Jul 18, 2021
6586432
improving documentation generator
SuperFola Jul 18, 2021
ad96bbb
tidying the code and adding more options to the cli
SuperFola Jul 18, 2021
4ec30d9
adding toggle to parse documentation comments from the builtins
SuperFola Jul 18, 2021
3a5d504
updating base generator to merge files with the same name (ignoring t…
SuperFola Jul 18, 2021
8847d0b
fixing workflow
SuperFola Jul 18, 2021
3887218
linter
SuperFola Jul 18, 2021
f0809de
adding test workflow
SuperFola Jul 18, 2021
ae5dbed
handling multiple authors
SuperFola Jul 18, 2021
99654a3
enhancing the C++ tokenizer and adding more details about the syntax
SuperFola Jul 20, 2021
da0e86f
removing @meta for now
SuperFola Jul 20, 2021
2b4c3ea
fixing the cpp doxygen comment extractor
SuperFola Jul 24, 2021
105cbea
adding argument to --html option to put the generated files in it
SuperFola Jul 24, 2021
2211d97
get loglevel from an environment variable
SuperFola Jul 24, 2021
f1034b9
add info on loglevel on the readme
SuperFola Jul 24, 2021
534e352
starting the generation of the html documentation
SuperFola Jul 24, 2021
837ab5e
enhancing the html generator
SuperFola Jul 24, 2021
2204563
finalizing the html generator, adding a table of contents
SuperFola Jul 24, 2021
a777717
adding an argument to specify the target arkscript version
SuperFola Jul 24, 2021
2690496
updating the ci to use the latest arkdoc cli
SuperFola Jul 24, 2021
c0eaea1
do not validate css/html
SuperFola Jul 24, 2021
cc59944
fixing test.yml workflow
SuperFola Jul 24, 2021
16239ac
mutualising code
SuperFola Jul 24, 2021
d6ca692
fixing github action linter
SuperFola Jul 24, 2021
1207ced
formatting code
SuperFola Jul 24, 2021
3b48d1c
fixing the generator to avoid listing an empty author
SuperFola Jul 31, 2021
dbdc9b9
do not display the parameter section if the function doesn't take any
SuperFola Aug 1, 2021
89fbc5e
adding a root-dir parameter so that we can generate the output wherev…
SuperFola Aug 1, 2021
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
37 changes: 0 additions & 37 deletions .github/workflows/ci.yml

This file was deleted.

39 changes: 39 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: super-linter

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
build:
name: Lint Code Base
runs-on: ubuntu-latest

steps:
- name: Checkout Code
uses: actions/checkout@v2
with:
# Full git history is needed to get a proper list of changed files within `super-linter`
fetch-depth: 0

################################
# Run Linter against code base #
################################
- name: Lint Code Base
uses: docker://github/super-linter:v3.13.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
VALIDATE_ALL_CODEBASE: false
VALIDATE_BASH: true
VALIDATE_BASH_EXEC: true
VALIDATE_DOCKERFILE: true
VALIDATE_DOCKERFILE_HADOLINT: true
VALIDATE_ENV: true
VALIDATE_JSON: true
VALIDATE_LATEX: true
VALIDATE_PYTHON_BLACK: true
VALIDATE_POWERSHELL: true
VALIDATE_SHELL_SHFMT: true
VALIDATE_SQL: true
37 changes: 37 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Tests CI

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
ci:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Checkout std
uses: actions/checkout@v2
with:
repository: ArkScript-lang/std
path: './std-latest'

- name: Checkout Ark
uses: actions/checkout@v2
with:
repository: ArkScript-lang/Ark
path: './ark-latest'

- name: Python
uses: actions/setup-python@v2
with:
python-version: '3.9'

- run: pip install -r requirements.txt
- run: |
export ARKDOC_LOGLEVEL=DEBUG
python -m arkdoc 3.1.0 std-latest/ ark-latest/src/Builtins --html out || exit 1
8 changes: 6 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
docs/
source/
*.ark
*.arkc
*.py[ouc]
__pycache__/
venv/
out/
67 changes: 0 additions & 67 deletions ArkDoc.rb

This file was deleted.

18 changes: 12 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Change Log

## 1.0.0
## [Unreleased]
### Added
- markdown file generation
- mkdocs tree support
- doc html generation

## 1.0.1
### Changed
- rewriting the project in Python 3

## [v0.0.2] - 2020-12-28
### Added
- options : `--md` for generation of markdown files only, `--build` for generate the static site and `--source` to set path of source code for generate site or markdown file
- default theme (dark)
Expand All @@ -15,4 +15,10 @@
- code structure
- Review of : Lexer, Parser and Generator
- syntax
- generate option
- generate option

## [v0.0.1] - 2020-08-31
### Added
- markdown file generation
- mkdocs tree support
- doc html generation
87 changes: 0 additions & 87 deletions Cli.rb

This file was deleted.

Loading