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

WIP Refactor docs to be consistent with other kartoza projects #304

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

timlinux
Copy link
Collaborator

@timlinux timlinux commented Dec 6, 2023

Key improvements:

  • move docs to their own folder rather than mixing in with the source tree
  • nix-shell for a repeatable build env (HTML AND PDF)
  • added pdf build workflow, templates etc.
  • consistency with other kartoza projects

There are a few tweaks I need to make before we can merge:

  • update GH workflow for publishing docs
  • add some missing MKDocs plugins and directives

@timlinux timlinux requested a review from Samweli December 6, 2023 10:37
Copy link
Contributor

badge

Plugin zip package for the changes in this PR has been successfully built!.

Download the plugin zip file here https://github.com/kartoza/cplus-plugin/suites/19903545378/artifacts/1177899872

Copy link
Collaborator

@Samweli Samweli left a comment

Choose a reason for hiding this comment

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

@timlinux I have made several updates to solve issues with the CI tests failing, we now need to change the documentation actions workflow in order to be able to deploy the documentation site into the github pages.

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