Skip to content

Commit

Permalink
Move the documentation to the GitHub wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Jun 15, 2024
1 parent 041b047 commit 434da2c
Show file tree
Hide file tree
Showing 12 changed files with 3 additions and 257 deletions.
34 changes: 0 additions & 34 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,37 +29,3 @@ jobs:
run: ant install
- name: Run tests
run: ant -emacs test
deploy:
needs: test
runs-on: ubuntu-latest
steps:
- name: Fetch sources
uses: actions/checkout@v4
- name: Set up Java
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 21
- name: Set up Ant
uses: cedx/setup-ant@v2
with:
optional-tasks: true
- name: Set up Python
uses: actions/setup-python@v5
with:
cache: pip
python-version: 3.12
- name: Cache dependencies
uses: actions/cache@v4
with:
path: ~/.ivy2/cache
key: ${{runner.os}}-ivy-${{hashFiles('**/ivy.xml')}}
restore-keys: ${{runner.os}}-ivy-
- name: Install dependencies
run: |
ant install
pip install --requirement=etc/requirements.txt
- name: Deploy documentation
run: |
ant doc
mkdocs gh-deploy --config-file=etc/mkdocs.yaml --force
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
/.idea/
/*.iml
/bin/
/docs/api/
/etc/http-client.private.env.json
/lib/
/src/picocli/
/var/
/www/
/wiki/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
Find the instances of an executable in the system path, in [Java](https://www.oracle.com/java).

## Documentation
- [User guide](https://docs.belin.io/which.java)
- [API reference](https://docs.belin.io/which.java/api)
- [User guide](https://github.com/cedx/which.java/wiki)
- [Examples](https://github.com/cedx/which.java/tree/main/example)

## Development
- [Git repository](https://github.com/cedx/which.java)
Expand Down
13 changes: 0 additions & 13 deletions build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,6 @@
</jar>
</target>

<target name="doc" description="Builds the documentation" depends="build">
<copy file="CHANGELOG.md" toFile="docs/changelog.md"/>
<copy file="LICENSE.md" toFile="docs/license.md"/>
<delete dir="docs/api"/>
<javadoc sourcePath="src" destDir="docs/api" packageNames="${vendor.id}.*" windowTitle="${project.title}"/>
</target>

<target name="install" description="Installs the project dependencies">
<mkdir dir="lib"/>
<ivy:retrieve log="download-only" sync="true"/>
Expand Down Expand Up @@ -100,12 +93,6 @@
<java sourceFile="example/${class}.java" classPathRef="project.classpath" failOnError="true" fork="true"/>
</target>

<target name="serve" description="Starts the development server" depends="doc">
<exec executable="mkdocs">
<arg line="serve --config-file=etc/mkdocs.yaml"/>
</exec>
</target>

<target name="test" description="Runs the test suite." depends="build">
<javac srcDir="test" destDir="bin" classPathRef="project.classpath" includeAntRuntime="false">
<compilerarg value="-proc:full"/>
Expand Down
Binary file removed docs/favicon.ico
Binary file not shown.
1 change: 0 additions & 1 deletion docs/favicon.svg

This file was deleted.

16 changes: 0 additions & 16 deletions docs/index.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/styles.css

This file was deleted.

96 changes: 0 additions & 96 deletions docs/usage/api.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/usage/cli.md

This file was deleted.

61 changes: 0 additions & 61 deletions etc/mkdocs.yaml

This file was deleted.

1 change: 0 additions & 1 deletion etc/requirements.txt

This file was deleted.

0 comments on commit 434da2c

Please sign in to comment.