Skip to content

DOC: Re-enable the PDF build of documentation at readthedocs? #3129

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.

Sign up for GitHub

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

Jump to bottom
Open
oesteban opened this issue Jan 2, 2020 · 3 comments
Open

DOC: Re-enable the PDF build of documentation at readthedocs? #3129

oesteban opened this issue Jan 2, 2020 · 3 comments

Comments

@oesteban
Copy link
Contributor

oesteban commented Jan 2, 2020

I have disabled the PDF builds after merging #3124. It is probably something easy to fix, but is there a strong reason to keep building the PDF output?
oesteban added a commit to oesteban/nipype that referenced this issue Jan 2, 2020
@oesteban
DOC: Documentation overhaul
cb1e376 
Building on top of nipy#3119 and nipy#3129, this PR makes a deep revision of the
documentation:

  * Added a new ``build_docs`` job to CircleCI to test how it renders.
  * Minimized external machinery (under ``/tools/``) when building the
    documentation:

      1. Some minimal modifications to sphinx extensions (apidoc,
         napoleon) allow the generation of special documentation
         for nipype interfaces, as it used to be before this PR
      2. A new sphinx extension (``nipype.sphinxext.apidoc``) takes
         care of parsing and rendering inputs and outputs. They now
         look like the parameters/arguments of functions when formatted
         with numpydoc.

  * Revised the description of many interfaces and the documentation of
    the main class and the input/output specs.
  * Revised the structure of the navbar, separating out
    User-Guide/Examples, Interfaces-Index, and Devs' documentation.
  * Minimized the number of WARNINGS at documentation build to 5 (4 of
    them coming out from the auto-generated SEM tools).
effigies pushed a commit to effigies/nipype that referenced this issue Jan 6, 2020
@oesteban @effigies
DOC: Documentation overhaul
a51b95a 
Building on top of nipy#3119 and nipy#3129, this PR makes a deep revision of the
documentation:

  * Added a new ``build_docs`` job to CircleCI to test how it renders.
  * Minimized external machinery (under ``/tools/``) when building the
    documentation:

      1. Some minimal modifications to sphinx extensions (apidoc,
         napoleon) allow the generation of special documentation
         for nipype interfaces, as it used to be before this PR
      2. A new sphinx extension (``nipype.sphinxext.apidoc``) takes
         care of parsing and rendering inputs and outputs. They now
         look like the parameters/arguments of functions when formatted
         with numpydoc.

  * Revised the description of many interfaces and the documentation of
    the main class and the input/output specs.
  * Revised the structure of the navbar, separating out
    User-Guide/Examples, Interfaces-Index, and Devs' documentation.
  * Minimized the number of WARNINGS at documentation build to 5 (4 of
    them coming out from the auto-generated SEM tools).
@effigies
Copy link
Member

effigies commented Jan 6, 2020

A PDF is useful just as a single archivable object.

@oesteban
Copy link
Contributor Author

oesteban commented Jan 6, 2020

But are we keeping such archive? Would we like to start with it if not?

@effigies
Copy link
Member

effigies commented Jan 6, 2020

ReadTheDocs keeps old versions... We could also add the PDF to the releases, if we want to duplicate to GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@effigies @oesteban