Skip to content

Conversation

t-sommer
Copy link

@t-sommer t-sommer commented Aug 1, 2025

fixes #2320

Build with

sudo docker run --rm -it -v $PWD:/documents/ asciidoctor/docker-asciidoctor asciidoctor -B /documents/ -b html5 --failure-level WARN -v --attribute=revnumber=3.7-dev --attribute=revdate=$(date +%F) docs/index.adoc

TODOs:

  • Clean up CSS
  • Set up CI
  • Remove *.tex files

@HansOlsson HansOlsson self-requested a review August 4, 2025 12:17
Copy link
Collaborator

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why?

And why are all files having weird names with leading numbers?

@HansOlsson
Copy link
Collaborator

HansOlsson commented Aug 4, 2025

Additionally we have pdf and html at specification.modelica.org, how does this compare?
My experience with generating pdf from markdown (using pandoc which also should work for ascii-doc) for the tutorial was that it did NOT work well out of the box.

Having the revision number outside of the document also seems weird.

@henrikt-ma
Copy link
Collaborator

Our current sources have lots of semantic markup in the form of LaTeX macros and environments. This allows the generated documents to be styled based on semantics, helps enforcing consistent throughout the entire specification, and preserves the possibility of future migration to other formats supporting semantic markup. How does the AsciiDoc solution compare in this regard (I do not know AsciiDoc well enough my self to be able to judge based on the files provided here)?

@HansOlsson
Copy link
Collaborator

Our current sources have lots of semantic markup in the form of LaTeX macros and environments. This allows the generated documents to be styled based on semantics, helps enforcing consistent throughout the entire specification, and preserves the possibility of future migration to other formats supporting semantic markup. How does the AsciiDoc solution compare in this regard (I do not know AsciiDoc well enough my self to be able to judge based on the files provided here)?

That was also one of my concerns, and just looking at the source I could see one issue: inline code has lost the language-information (i.e., as if we had used \verb instead of \lstinline).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revisit Sphinx
3 participants