Skip to content

MRG, DOC: Deduplicate MNE manual pages#6730

Merged
larsoner merged 10 commits intomne-tools:masterfrom
drammock:deduplicate-manual
Sep 4, 2019
Merged

MRG, DOC: Deduplicate MNE manual pages#6730
larsoner merged 10 commits intomne-tools:masterfrom
drammock:deduplicate-manual

Conversation

@drammock
Copy link
Copy Markdown
Member

@drammock drammock commented Sep 3, 2019

This PR removes some of the redundancy in the doc/manual tree.

  • References to MNE-Python functions were mostly moved into sidebars rather than integrated into the original manual text.
  • The sections have been put into correct order in the TOC page.
  • Text has been reflowed to fit a 79-char column (except for long :math: blocks or tables)
  • some improvements to folder path formatting, e.g., using the rST :file: role instead of double backticks

@codecov
Copy link
Copy Markdown

codecov bot commented Sep 3, 2019

Codecov Report

❗ No coverage uploaded for pull request base (master@d247e55). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master    #6730   +/-   ##
=========================================
  Coverage          ?   89.48%           
=========================================
  Files             ?      420           
  Lines             ?    75643           
  Branches          ?    12393           
=========================================
  Hits              ?    67690           
  Misses            ?     5142           
  Partials          ?     2811

@larsoner
Copy link
Copy Markdown
Member

larsoner commented Sep 3, 2019

CircleCI complaints are legitimate. I fixed a few of them but there are more

@drammock
Copy link
Copy Markdown
Member Author

drammock commented Sep 3, 2019

Thanks for fixing the sidebars. Circle is happy so looks like I got all the crossrefs... sorry i didn't test locally first (it takes forever on my laptop, and I don't have remote access to my UW machine at the moment because it changed subnets recently).

@drammock drammock changed the title DOC: Deduplicate MNE manual pages MRG, DOC: Deduplicate MNE manual pages Sep 3, 2019
@jasmainak
Copy link
Copy Markdown
Member

couple of comments
-- isn't the C API reference still being duplicated in the Manual?
-- what is the version of the manual here? It probably doesn't match the latest one, should we make a note of this?
-- the SSP was also part of the original manual? Is this part being duplicated still?

@drammock
Copy link
Copy Markdown
Member Author

drammock commented Sep 3, 2019

couple of comments
-- isn't the C API reference still being duplicated in the Manual?

it's content only exists on one page. It is listed in the Manual TOC because chapter 1 of the manual had similar summary tables of the commands. Do you think we should remove it from the manual TOC?

-- what is the version of the manual here? It probably doesn't match the latest one, should we make a note of this?

we refer to it as "The web version of Matti Hämäläinen’s original MNE-C manual". I don't know how close it is to the most current version, doesn't really seem worth the effort to go through with a fine-toothed comb to figure it out. What do you suggest for wording?

-- the SSP was also part of the original manual? Is this part being duplicated still?

I think the standalone SSP page covers different material than what's in the manual (and its examples are all Python-specific). But I'll double check.

@jasmainak
Copy link
Copy Markdown
Member

Do you think we should remove it from the manual TOC?

I would say so, the TOC is too long to parse easily. We also have it here: https://15088-1301584-gh.circle-artifacts.com/0/dev/manual/c_reference.html#c-reference

What do you suggest for wording?

I was going to suggest linking to the actual pdf of the latest version and nuke the web version (but that may make @agramfort sad)

@drammock
Copy link
Copy Markdown
Member Author

drammock commented Sep 3, 2019

Do you think we should remove it from the manual TOC?

I would say so, the TOC is too long to parse easily. We also have it here: https://15088-1301584-gh.circle-artifacts.com/0/dev/manual/c_reference.html#c-reference

OK will do

What do you suggest for wording?

I was going to suggest linking to the actual pdf of the latest version and nuke the web version (but that may make @agramfort sad)

The PDF is behind a free-wall (users must log in with an account to even download it). Until that policy changes I don't think we should take down the HTML version.

@drammock
Copy link
Copy Markdown
Member Author

drammock commented Sep 3, 2019

@jasmainak you were right about the SSP being duplicated. I've fixed that now, and removed the C API from the manual TOC.

@jasmainak
Copy link
Copy Markdown
Member

The PDF is behind a free-wall (users must log in with an account to even download it). Until that policy changes I don't think we should take down the HTML version.

I think this must change. I will talk to @mshamalainen tomorrow

@drammock
Copy link
Copy Markdown
Member Author

drammock commented Sep 3, 2019

OK. In the meantime I think we should still merge this when CIs come back green. If we need to decommision the whole set of manual pages it will be a larger effort (due to all the crossrefs pointing there) and we should probably get buy-in from more of the community first.

@larsoner larsoner merged commit daa0458 into mne-tools:master Sep 4, 2019
@larsoner
Copy link
Copy Markdown
Member

larsoner commented Sep 4, 2019

Thanks @drammock

@jasmainak
Copy link
Copy Markdown
Member

jasmainak commented Sep 4, 2019

So, just to finish the story @mshamalainen is totally fine with putting the pdf manual on github. Let me know if you need my help there.

@drammock drammock deleted the deduplicate-manual branch September 5, 2019 22:47
alexrockhill pushed a commit to alexrockhill/mne-python that referenced this pull request Oct 1, 2019
* delete empty page

* merge duplicate "inverse" pages

* merge duplicate "forward" pages

* merge duplicate "morph" pages

* formatting in appendix misc

* update manual TOC page

* FIX: Some fixes

* fix crossrefs

* remove C API from manual TOC

* deduplicate SSP section
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.

4 participants