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

docs: Generate manual from markdown #3849

Draft
wants to merge 45 commits into
base: main
Choose a base branch
from
Draft

Conversation

landam
Copy link
Member

@landam landam commented Jun 16, 2024

Goal

Build user manual from Markdown using mkdocs

image

How to test

  1. Install requirements, see man/mkdocs/requirements.txt
  2. Compile GRASS
  3. Open dist.x86_64-pc-linux-gnu/docs/markdown/site/index.html in web browser

Tasks

  • fix gui/script/ compilation
  • fix code blocks
  • fix commit link
  • implement build_md.py and indices
  • add missing meta page comments to MD files (how to do it with pandoc?)
  • remove toc-related code from mkmarkdown.py and change mkdocs style to show page-related TOC
  • fix "## DESCRIPTION" appearance from keyword list
  • fix CI
  • separate makefile rules (Markdown.make, MarkdownRules.make) ?
  • make install
  • logo points to index.html
  • site_name to "GRASS GIS 8.5.0dev Reference Manual"
  • fix menu items

Tasks before merge

  • rebase main and regenerate MD files from HTML once again

Tasks after merge(?)

  • remove rest-related scripts
  • generate man from markdown
  • remove HTML-based documentation and clean-up scripts

Notes

How HTML was converted to MD:

for f in `find . -name *.html`; do echo $f; pandoc -i $f -o ${f%%.html}.md;done
@landam landam marked this pull request as draft June 16, 2024 13:28
@landam landam self-assigned this Jun 16, 2024
@landam landam added the docs label Jun 16, 2024
@landam landam added this to the 8.5.0 milestone Jun 16, 2024
@github-actions github-actions bot added windows Microsoft Windows specific GUI wxGUI related vector Related to vector data processing raster Related to raster data processing temporal Related to temporal data processing Python Related code is in Python database Related to database management libraries module general display imagery tests Related to Test Suite raster3d misc labels Jun 16, 2024
man/build_keywords.py Show resolved Hide resolved
man/build_keywords.py Outdated Show resolved Hide resolved
man/build_keywords.py Outdated Show resolved Hide resolved
man/build_keywords.py Outdated Show resolved Hide resolved
man/build_keywords.py Outdated Show resolved Hide resolved
man/build_keywords.py Show resolved Hide resolved
man/build_keywords.py Outdated Show resolved Hide resolved
man/build_keywords.py Outdated Show resolved Hide resolved
landam and others added 10 commits June 18, 2024 14:42
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions github-actions bot added the CSS Related code is in CSS label Jun 18, 2024
man/build_full_index.py Show resolved Hide resolved
man/build_full_index.py Outdated Show resolved Hide resolved
man/build_full_index.py Outdated Show resolved Hide resolved
man/build_full_index.py Outdated Show resolved Hide resolved
man/build_full_index.py Outdated Show resolved Hide resolved
man/build_graphical_index.py Outdated Show resolved Hide resolved
man/build_graphical_index.py Outdated Show resolved Hide resolved
man/build_graphical_index.py Outdated Show resolved Hide resolved
man/build_keywords.py Outdated Show resolved Hide resolved
@echoix echoix changed the title Generate manual from markdown Jun 20, 2024
landam and others added 10 commits June 26, 2024 15:03
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C Related code is in C CSS Related code is in CSS database Related to database management display docs general GUI wxGUI related imagery libraries misc module Python Related code is in Python raster Related to raster data processing raster3d temporal Related to temporal data processing tests Related to Test Suite vector Related to vector data processing windows Microsoft Windows specific
1 participant