-
-
Notifications
You must be signed in to change notification settings - Fork 145
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/mkdoc #1379
Draft
PGijsbers
wants to merge
25
commits into
develop
Choose a base branch
from
docs/mkdoc
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Docs/mkdoc #1379
Conversation
This file contains 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
order plugin is important: first gen_files needs to generate the virtual files for the jupyter extension to render them
I also tried `no_input: true` but that removed the whole cell.
IMO: merge first and focus on user stories/use cases afterward to refactor the documentation. That is, likely move all the old documentation to an "extended example" list and only keep a set of user stories / use cases in the new main documentation. |
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.
Work converting the Python docs to mkdocs. Left to do before it's "functional":
Otherwise, most of the files have been converted.
That said, the documentation really needs a rewrite. I refrained from changing any content as much as I could, with rare exceptions. But the main problems, to me, are:
How should we move forward with this PR? I don't mind rewriting (some of) this documentation, but I think it would be better to merge this at one point so it's easier to collaborate. WDYT? @eddiebergman @LennartPurucker