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

Convert all of docs to markdown #392

Closed
joeshannon opened this issue Mar 15, 2024 · 3 comments · Fixed by #448
Closed

Convert all of docs to markdown #392

joeshannon opened this issue Mar 15, 2024 · 3 comments · Fixed by #448
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@joeshannon
Copy link
Contributor

Follow on from #359

joeshannon added a commit that referenced this issue Apr 10, 2024
This replaces the previous rst version with the exact version in 2.0.1
of the python-copier-template which blueapi is currently based on.

Relates to #359 and #392.
DiamondJoseph pushed a commit that referenced this issue Apr 12, 2024
This replaces the previous rst version with the exact version in 2.0.1
of the python-copier-template which blueapi is currently based on.

Relates to #359 and #392.
joeshannon added a commit that referenced this issue Apr 12, 2024
This replaces the previous rst version with the exact version in 2.0.1
of the python-copier-template which blueapi is currently based on.

Relates to #359 and #392.
joeshannon added a commit that referenced this issue Apr 12, 2024
This replaces the previous rst version with the exact version in 2.0.1
of the python-copier-template which blueapi is currently based on.

Relates to #359 and #392.
@stan-dot
Copy link
Contributor

stan-dot commented May 1, 2024

using this script:
`#!/bin/bash

Define the path to the docs directory

DOCS_DIR="./docs"

Check if pandoc is installed

if ! command -v pandoc &> /dev/null
then
echo "pandoc could not be found, please install it first."
exit 1
fi

Convert all .rst files in the docs directory to .md

find "$DOCS_DIR" -type f -name "*.rst" | while read file; do
# Define the output filename by replacing the extension
output_file="${file%.rst}.md"

# Use pandoc to convert the file
pandoc "$file" -s -o "$output_file"

   # Remove the original .rst file after conversion
rm "$file"

# Optionally, echo the output file name
echo "Converted and removed '$file', created '$output_file'"

done

echo "Conversion complete."
`

@stan-dot
Copy link
Contributor

stan-dot commented May 1, 2024

possibly images need a different handling

@stan-dot
Copy link
Contributor

stan-dot commented May 1, 2024

did markdown import for images

@stan-dot stan-dot linked a pull request May 1, 2024 that will close this issue
1 task
ZohebShaikh pushed a commit that referenced this issue May 7, 2024
This replaces the previous rst version with the exact version in 2.0.1
of the python-copier-template which blueapi is currently based on.

Relates to #359 and #392.
@stan-dot stan-dot added the documentation Improvements or additions to documentation label May 16, 2024
@stan-dot stan-dot added this to the 1.0.0 milestone May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants