Skip to content

Commit

Permalink
Rename fmi_specification.adoc to index.adoc (modelica#592)
Browse files Browse the repository at this point in the history
to follow Asciidoctor best practices and simplify deployment
  • Loading branch information
t-sommer authored and andreas-junghanns committed Jul 12, 2019
1 parent c805050 commit 7e5b286
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
5 changes: 2 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ jobs:
python .circleci/validate_xml.py
- run:
name: Generate HTML
command: docker run -v ~/project/:/documents/ --name asciidoc-to-html asciidoctor/docker-asciidoctor asciidoctor --base-dir /documents/ --backend html5 --failure-level WARN docs/fmi_specification.adoc
command: docker run -v ~/project/:/documents/ --name asciidoc-to-html asciidoctor/docker-asciidoctor asciidoctor --base-dir /documents/ --backend html5 --failure-level WARN docs/index.adoc
- run:
name: Validate HTML
command: docker run -v ~/project/docs/:/documents/ 18fgsa/html-proofer /documents --only-4xx
- run:
name: Create archive
command: |
cd ~/project
zip fmi-standard.zip README.adoc CHANGELOG.adoc LICENSE.txt docs/fmi_specification.html docs/fmi-spec.css docs/images/* headers/*.h schema/*.xsd
zip fmi-standard.zip README.adoc CHANGELOG.adoc LICENSE.txt docs/index.html docs/fmi-spec.css docs/images/* headers/*.h schema/*.xsd
- store_artifacts:
path: ~/project/fmi-standard.zip
- run:
Expand All @@ -39,7 +39,6 @@ jobs:
git clone [email protected]:modelica/fmi-standard.org.git
rsync -a --delete --exclude *.adoc ~/project/docs/ ~/fmi-standard.org/docs/3.0-dev/
cd fmi-standard.org
mv docs/3.0-dev/fmi_specification.html docs/3.0-dev/index.html
git add docs/3.0-dev
git commit -m "Update generated specification from fmi-standard (${CIRCLE_SHA1:0:7})" || echo "No changes to commit"
git push
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ where `<fmi-standard>` is the path to the cloned repository

. Generate the HTML document
+
asciidoctor -B /documents/ -b html5 docs/fmi_specification.adoc
asciidoctor -B /documents/ -b html5 docs/index.adoc

`Alternative 2:` Ruby and the AsciiDoctor gem

Expand All @@ -41,12 +41,12 @@ where `<fmi-standard>` is the path to the cloned repository

. Generate the HTML document
+
asciidoctor -B <fmi-standard> -b html5 docs/fmi_specification.adoc
asciidoctor -B <fmi-standard> -b html5 docs/index.adoc
+
where `<fmi-standard>` is the path to the cloned repository


The generated `docs/fmi_specification.html` can be viewed with any modern web browser.
The generated `docs/index.html` can be viewed with any modern web browser.

== Using the issue tracker

Expand Down
File renamed without changes.

0 comments on commit 7e5b286

Please sign in to comment.