-
Notifications
You must be signed in to change notification settings - Fork 140
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 [ENH, DOC] Documentation PDF - automatic generation #797
Open
juangpc
wants to merge
40
commits into
mne-tools:main
Choose a base branch
from
juangpc:pdfmanual
base: main
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.
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
Codecov Report
@@ Coverage Diff @@
## main #797 +/- ##
=======================================
Coverage 29.52% 29.52%
=======================================
Files 450 450
Lines 39296 39296
=======================================
Hits 11603 11603
Misses 27693 27693
|
This reverts commit d9793ad.
juangpc
changed the title
[WIP, ENH, DOC] Documentation PDF - automatic generation
WIP [ENH, DOC] Documentation PDF - automatic generation
Aug 17, 2021
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.
Hi,
The pr will create a pdf from the markdown files in the
doc/gh-pages
folder. Eventually, it could turn into an independent repository with a gh action that we could download from the ci, and trigger whenever a pr was accepted into master.Coded in Python, and based in a Latex template, it creates two python modules (so far). One a basic
mne-cpp
core module with basic functions we might need during development, and another module related to the actual pdf generation.To do:
doc/gh-pages
folder.Python parser code:
Yes, the pr needs still some work.