Skip to content
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

Move to MyST as recommonmark and CommonMark are not supported #9560

Merged
merged 1 commit into from
Oct 14, 2022

Conversation

Mab879
Copy link
Member

@Mab879 Mab879 commented Sep 23, 2022

Description:

Move the docs to use MyST.

Rationale:

Closes #9076

@Mab879 Mab879 added the Documentation Update in project documentation. label Sep 23, 2022
@Mab879 Mab879 added this to the Backlog milestone Sep 23, 2022
@github-actions
Copy link

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment
Open in Gitpod

Oracle Linux 8 Environment
Open in Gitpod

@Mab879 Mab879 modified the milestones: Backlog, 0.1.65 Sep 23, 2022
@Mab879 Mab879 changed the title Move to MyST as recommonmakr and commanmark are not supported Move to MyST as recommonmark and CommonMark are not supported Sep 26, 2022
Copy link
Member

@ggbecker ggbecker left a comment

Choose a reason for hiding this comment

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

We need to update the CMakefiles to reflect this change as they rely on recommonmark for various things. For example:

message(STATUS "python recommonmark module (optional): ${PY_RECOMMONMARK}")
but there's more, search for recommonmark and PY_RECOMMONMARK.

The documentation will all require some updates in the dependencies section for the documentation build part.

@Mab879
Copy link
Member Author

Mab879 commented Sep 26, 2022

I have updated the CMake files and a few other items; there should be no doc changes needed since we instruct to install from docs/requirements.txt.

@codeclimate
Copy link

codeclimate bot commented Sep 26, 2022

Code Climate has analyzed commit d08a413 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 40.6% (0.0% change).

View more on Code Climate.

@ggbecker ggbecker self-assigned this Oct 14, 2022
@ggbecker ggbecker merged commit a95ee6d into ComplianceAsCode:master Oct 14, 2022
@Mab879 Mab879 deleted the move_to_myst branch October 14, 2022 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update in project documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs use depreatated dependanices
2 participants