Skip to content

Adapt folder layout to enable pandoc integration #69

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

Merged
merged 60 commits into from
Feb 6, 2022
Merged

Conversation

vulder
Copy link
Collaborator

@vulder vulder commented Jun 6, 2021

Enabling automatic document creating with pandoc requires a different folder layout, so we can separate sources files, tools, configs, etc. This PR prepares the repository for further pandoc integration.

TODO:

  • Improve spell checking
    • Better spelling error reporting (users want to see file/line numbers)
    • Do we need two different spelling exclude lists?
    • Fix wrong spell checking error
  • Test deployment
  • Fix hard coded source detection
  • Unify multiple places where we lookup/compute the document version
  • Regenerate and check tools (old folder)
  • Update skeleton to MD table format
  • Generate include parts for main.md
  • Setup CI for tool unittests

Future TODOs:

  • Refactor preprocessor stage into main generator
    • Refactor code
    • Write tests
  • Refactor building of knowledge_areas section
    • Refactor code
    • Write tests

Pandoc ob ubuntu-20.04 seems to have a bug when rendering one of our topcs. However, misspelling the section works.

@vulder vulder requested a review from mdadams June 6, 2021 20:04
@vulder vulder removed the request for review from mdadams September 20, 2021 20:01
@vulder vulder requested a review from jcvw November 1, 2021 21:50
Copy link
Collaborator

@jcvw jcvw left a comment

Choose a reason for hiding this comment

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

Wow, that was a ton of work. I have a few minor comments, nothing blocking.

@vulder vulder requested a review from mdadams November 3, 2021 17:55
@vulder vulder force-pushed the AdaptFolderLayout branch from 635ba86 to 543d219 Compare February 6, 2022 21:49
@vulder vulder merged commit cfe4a20 into master Feb 6, 2022
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.

2 participants