docs: Move from sphinx to Mkdocs - #89
Merged
Merged
Conversation
chore: Fix gitattributes causing zip file to show as modified chore: Add devcontainer
alhendrickson
marked this pull request as draft
September 1, 2026 12:24
Member
|
lgtm |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See here for the results:
The nifi Readthedocs page:
https://cogstack-platform-toolkit--89.org.readthedocs.build/projects/nifi/en/89/
And then the integrated docs page:
https://cogstack-platform-toolkit--122.org.readthedocs.build/en/122/data-engineering/nifi/
Notes
Generally tried to keep this as small as possible and not change the actual contents of the docs. It should generally look like it does today with a different theme.
Later would probably want to reorganise to make the most of the nav sections / headers that mkdocs can do. I've tried to keep it exactly as is today for now.
All the setup / config etc should be the same as in the medcat and medcat-trainer docs pages
index.md
docs/index.md is a straight copy+paste of the README.md. The snippet used before isn't going to work well later (see change in cogstack-nlp). Long term would want README.md to change to being content relevant for someone who has cloned it (like it is now), but index.md be relevant to someone viewing the docs page. For example showing the directory structure on the docs page isn't really needed.
attributes
.gitattributes change is to fix these coming up as modified on a new clone. These zip files probably should get deleted though as I see them listed .gitignore as well.