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

Support repeat_table_rows in Sphinx #674

Merged
merged 6 commits into from Sep 17, 2018

Conversation

akrabat
Copy link
Member

@akrabat akrabat commented Jun 26, 2018

Support the repeat-table-rows option in Sphinx.

Builds on #598 by rebasing and adding tests.

@akrabat akrabat requested a review from lornajane June 26, 2018 20:51
@akrabat akrabat changed the title Sphinx repeat table rows Support repeat_table_rows in Sphinx Jun 27, 2018
@akrabat akrabat added this to the 0.94 milestone Jun 27, 2018
@lornajane
Copy link
Contributor

The contents of this pull request look OK to me - the change is plausible, the tests pass and the output looks like the title of the pull request suggests. Although I think I'm doing something wrong because these tests seem to pass even on the master branch version of rst2pdf ....

I'm unclear how this feature looks from a user point of view. Is it a command line switch (it looks like it is) - so do we need to update some documentation and the output of rst2pdf --help ? What is the sphinx test doing? Is this something I'd come across as a user or some internal thing? Is there a way I could specify this in my source file rather than switching it at runtime?

@akrabat
Copy link
Member Author

akrabat commented Jul 8, 2018

The contents of this pull request look OK to me - the change is plausible, the tests pass and the output looks like the title of the pull request suggests. Although I think I'm doing something wrong because these tests seem to pass even on the master branch version of rst2pdf ....

The tests/input/test_repeat-table-rows.txt should pass on master as I created a test as there wasn't one for --repeat-table-rows.

The Sphinx test should fail on master though.

I'm unclear how this feature looks from a user point of view. Is it a command line switch (it looks like it is) - so do we need to update some documentation and the output of rst2pdf --help ? What is the sphinx test doing? Is this something I'd come across as a user or some internal thing? Is there a way I could specify this in my source file rather than switching it at runtime?

--repeat-table-rows is documented in https://github.com/akrabat/rst2pdf/blob/sphinx-repeat-table-rows/doc/rst2pdf.rst - I think that's the man page and is automatically pulled into the pdf manual?

The Sphinx test adds a new option to pdfbuilder (The Sphinx plugin) called pdf_repeat_table_rows which can then be set in conf.py. This wasn't documented, but is now!

The text now correctly notes that it is the pdf_repeat_table_rows config
setting that is used for the Sphinx test.
@akrabat akrabat merged commit 4a47c7c into rst2pdf:master Sep 17, 2018
akrabat added a commit that referenced this pull request Sep 17, 2018
@akrabat akrabat deleted the sphinx-repeat-table-rows branch December 18, 2019 09:32
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.

None yet

3 participants