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 [ENH, DOC] Documentation PDF - automatic generation #797

Open
wants to merge 40 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
905354a
Revert "MAINT: no app bundles"
juangpc Jul 23, 2021
3552de6
create script for pdf manual generation
juangpc Mar 11, 2021
82f9c6a
initial attempt to parsing the web
juangpc Mar 12, 2021
0f3198b
generate a list of valid web documents and web structure
juangpc Mar 13, 2021
bb195ee
change name to script
juangpc Mar 13, 2021
a076ec9
generate pdf draft structure
juangpc Mar 17, 2021
c7a8a3a
add latex extensions to gitignore
juangpc Mar 17, 2021
59faae8
add initial tex file
juangpc Mar 17, 2021
ed94530
update python script generate latex code
juangpc Mar 17, 2021
b1c6e29
add logo image with text
juangpc Mar 17, 2021
5873b06
add publications style
juangpc Mar 17, 2021
e23c78c
add pdf documentation file to gitignore
juangpc Mar 17, 2021
6de7e84
generate template tex file
juangpc Mar 17, 2021
6f45821
improve python markdown parser
juangpc Mar 17, 2021
da43823
modularize python script
juangpc Mar 17, 2021
251cabb
links and images working fine
juangpc Mar 18, 2021
686ddf6
update python script todos
juangpc Mar 18, 2021
e81d84e
make web parser compare with parent and grand_parent
juangpc Mar 18, 2021
34b9d45
improvement in regular expression handling
juangpc Mar 19, 2021
2baa5f5
move trash.py
juangpc Mar 24, 2021
353f4a5
add main mne-cpp python module
juangpc Mar 25, 2021
9594605
add fucntion inline image html code
juangpc Mar 25, 2021
07855b1
add more examples to trashy.py
juangpc Mar 25, 2021
c190975
file path and extension regex done
juangpc Mar 27, 2021
b7904ed
libs working
juangpc Mar 30, 2021
1b301fc
inline italic text
juangpc Mar 31, 2021
efd7990
parse bold inline
juangpc Mar 31, 2021
95c78bd
itemize list
juangpc Mar 31, 2021
67ff90f
filePathExt parser function
juangpc Mar 31, 2021
f30036e
parse inline Images
juangpc Mar 31, 2021
0fadb40
improve parse inline html img
juangpc Apr 1, 2021
7a63ea9
parse table working
juangpc Apr 1, 2021
09aedd1
cleanup and image function definitions
juangpc Apr 1, 2021
906d328
clean print form pdf_doc
juangpc Apr 1, 2021
ca679ac
clean up add example demo script for module
juangpc Apr 1, 2021
c6201db
change name none_if_empty
juangpc Apr 1, 2021
875668d
parse headers
juangpc Apr 1, 2021
402f2ae
parse links
juangpc Apr 1, 2021
1eeeb22
enhance code coherence
juangpc Apr 2, 2021
4b3f914
parsinglists not working
juangpc Apr 2, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ jobs:
# make install -j
- name: Configure and compile MNE-CPP
run: |
../Qt5_binaries/bin/qmake -r MNECPP_CONFIG+=noTests MNECPP_CONFIG+=noExamples MNECPP_CONFIG+=static
../Qt5_binaries/bin/qmake -r MNECPP_CONFIG+=noTests MNECPP_CONFIG+=noExamples MNECPP_CONFIG+=static MNECPP_CONFIG+=withAppBundles
make -j
make install -j
- name: Deploy binaries
Expand Down Expand Up @@ -339,7 +339,7 @@ jobs:
make install
- name: Configure and compile MNE-CPP
run: |
qmake -r MNECPP_CONFIG+=noTests MNECPP_CONFIG+=noExamples MNECPP_CONFIG+=withBrainFlow MNECPP_CONFIG+=withLsl
qmake -r MNECPP_CONFIG+=noTests MNECPP_CONFIG+=noExamples MNECPP_CONFIG+=withBrainFlow MNECPP_CONFIG+=withLsl MNECPP_CONFIG+=withAppBundles
make -j4
- name: Deploy binaries (MacOS)
run: |
Expand Down
17 changes: 16 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,19 @@ Makefile
mne-cpp.pro.user*

# FFTW
/include/3rdParty/fftw
/include/3rdParty/fftw

# Documentation
/doc/pdf/*.aux
/doc/pdf/*.bbl
/doc/pdf/*.blg
/doc/pdf/*.fdb_latexmk
/doc/pdf/*.fls
/doc/pdf/*.log
/doc/pdf/*.out
/doc/pdf/*.toc
/doc/pdf/*.gz
/doc/pdf/*.pdf



14 changes: 14 additions & 0 deletions doc/gh-pages/blabla.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

---
title: Home
has_children: true
nav_order: 1
---

# The MNE-CPP Project

![A framework for electrophysiology](images/partners.png)



MNE-CPP is a cross-platform, open-source framework which offers a variety of software tools to the neuroscientific research community. We provide applications for the acquisition and processing of MEG/EEG data, both in real-time and offline. All applications are built on top of our cross-platform library which is available via an API and can be used to develop new tools.
2 changes: 1 addition & 1 deletion doc/gh-pages/pages/documentation/analyze_coregistration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This plugin lets you co-register your subject's BEM-files with a digitizer set o

The following sections will show you how to use the plugin and introduce good practice.

![](../../images/analyze/mne_an_coreg.png)
![MNE Analyze Coregistration plugin.](../../images/analyze/mne_an_coreg.png)

## Prerequisites

Expand Down
Loading