Skip to content

Conversation

@boegel
Copy link
Member

@boegel boegel commented Jan 3, 2023

requires:

The update-version-specific-docs.sh can be used to auto-generate the pages under version-specific/ .
To be clear: the intention is to run this script manually, as a part of the release process (see also here).

There are a couple of minor issues that we should try and resolve, but overall this should be good enough as a first iteration to replace what we currently have at https://easybuild.readthedocs.io/en/latest/version-specific ; we can open issues on whatever small problems we find along the way, and fix them in follow-up PRs.

The included updated .md pages under version-specific correspond to the current develop branches of EasyBuild (pre-v4.7.0)

@boegel boegel added the porting-to-mkdocs Porting effort from Sphinx/.rst to MkDocs/.md label Jan 3, 2023
@@ -1,16 +1,402 @@
# List of easyblocks {: #vsd_list_easyblocks }

## Overview of generic easyblocks {: #generic_easyblocks }
Copy link
Member Author

Choose a reason for hiding this comment

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

I've moved the #generic_easyblocks anchor to generic-easyblocks.md

@boegel boegel requested a review from branfosj January 3, 2023 21:26
@boegel
Copy link
Member Author

boegel commented Jan 3, 2023

@branfosj I'm hoping we can ignore the failing MarkDown linting and codespell tests for now, and get this merged as is, since easybuilders/easybuild-framework#4117 is blocking the release of EasyBuild v4.7.0...

@branfosj
Copy link
Member

branfosj commented Jan 4, 2023

For the spelling:

@branfosj branfosj merged commit d7567e2 into easybuilders:main Jan 4, 2023
@boegel boegel deleted the auto_gen_docs branch January 4, 2023 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

porting-to-mkdocs Porting effort from Sphinx/.rst to MkDocs/.md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants