Re: [sphinx-dev] sorry for the insistence...

[Erik Hetzner]

At Tue, 23 Oct 2012 06:13:04 -0700 (PDT),
Renato wrote:
> 
> but I have some prob. making .pdf.
> 
> this code:
>
> […]

Whether you are in a section, part, subsection, etc. is determined by
the overall structure of the document, not by the particular character
(#, *, -, ...) used as an underline or underline/overline. Try the following:

#
title, ignore
#

unique parts

**
part 1
**

chap 1
--
 
etc.

chap 2
--

etc.

best, Erik
Sent from my free software system .
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Re: [sphinx-dev] Re: How to include bibliography from BibTeX

[Erik Hetzner]

At Thu, 13 Sep 2012 13:06:56 -0700 (PDT),
Ramon wrote:
> 
> Same here -- any update on this?

It needs work, but if you use zotero you can use zot4rst,

  https://bitbucket.org/egh/zot4rst

I hope to have some time to decouple this from zotero soon.

best, Erik
Sent from my free software system .
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Re: [sphinx-dev] Clarifying location of bibliographic fields

[Erik Hetzner]

At Thu, 09 Aug 2012 22:36:09 -0700,
Erik Hetzner wrote:
> 
> Hi all,
> 
> Should bibliographic fields come before or after the document title in
> the index.rst file?

Hi all,

I found the answer here:

  http://sphinx.pocoo.org/markup/misc.html#file-wide-metadata

It should come before if one doesn’t want it displayed in the output.

best, Erik
Sent from my free software system <http://fsf.org/>.
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

[sphinx-dev] Clarifying location of bibliographic fields

[Erik Hetzner]

Hi all,

Should bibliographic fields come before or after the document title in
the index.rst file?

That is, either::

  ===
   Title
  ===

  :author: John Doe

or::

  :author: John Doe

  ===
   Title
  ===

This conversation says after:

  https://groups.google.com/d/topic/sphinx-dev/R2C85gl9ISQ/discussion

But the actual code (and tests) seems to work only on fields that come
before. After seems to be the location defined by docutils.

best, Erik
Sent from my free software system .
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Re: [sphinx-dev] Re: Bug in epub: toctree hidden --> no text

[Erik Hetzner]

At Thu, 16 Feb 2012 18:03:48 +0100,
Roland Meister wrote:
> 
> Am Mittwoch, den 15.02.2012, 21:27 -0800 schrieb Erik Hetzner:
>
> […]
>
> Hi Erik,
> did you really use the version of sphinx from my branch?
> Please check which version of sphinx you are using.
> The results you describe seem to indicate that you are
> using a version without my changes.
> They have not yet been pulled into the main
> branch of sphinx.

Hi Roland,

Thanks for your patience! It was indeed my mistake. I think I must not
have loaded the virtualenv where your version was installed. I started
a clean virtualenv and rechecked, and I can page through the work.

Thanks so much for the fix!

> You can get my version from
> http://bitbucket.org/rolmei/sphinx-epub.
> Please also apply the attached patch, it has not
> been added yet to the bitbucket repository
> (see the attachment for a slightly different patch).
> 
> In either case, send me the epub (and the rst sources).
> I'll take a look at it.
> 
> By the way, that version also contain epub theme
> configuration options to remove the relabar1 and footer
> sections. You don't need the custom theme any more
> if you set the options.

Thanks, that might be useful. I am trying to put together a site like
readthedocs for epubs. I am starting with a very basic theme.

best, Erik
Sent from my free software system <http://fsf.org/>.
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Re: [sphinx-dev] Re: Bug in epub: toctree hidden --> no text

[Erik Hetzner]

At Wed, 15 Feb 2012 09:35:37 -0800 (PST),
rolmei wrote:
> 
> Hi Erik,
> you are setting the hidden attribute on the root toc entry?
> Then, indeed, the navMap element in toc.ncx is empty and useless.
> My use case was to hide only the toc in non-root toc entries.

Hi Roland,

Thank you for your response!

My primary reason for worrying about this is that I would like to be
able to build epubs that do not have a table of contents in the main
text, but that instead use a ereaders built-in navigation system,
features which exist on all ereaders that I know of. I think that
hidden toctrees are the right feature to use for this, but I could be
wrong. I should note that I am using a custom theme that does not
contain any navigation links at all.

Here are the results of my test, using your patch. I created a test
document with a root toctree entry and 2 child toctrees, each with a
single document beneath them. (I can supply these files if you like.)

If I use hidden in the root toctree, I indeed get an empty ,
and an empty  in the content.opf. In calibre I cannot see
anything in the generated epub file. Nor can I view any content in the
bookworm.oreilly.com, nor on my nook.

If I remove hidden from the root toctree, and add it to a single child
toctree, I am unable to access the child toctree. I am unable to
navigate in any way to the child of the hidden toctree, in calibre
viewer, on bookworm.oreilly.com, and on my nook.

I don’t think this is correct behavior, because according to the
sphinx docs:

  This will still notify Sphinx of the document hierarchy, but not
  insert links into the document at the location of the directive –
  this makes sense if you intend to insert these links yourself, in a
  different style, or in the HTML sidebar. [1]

I think that the  element of the content.opf or the toc.ncx
file should be considered like an HTML sidebar.

1. http://sphinx.pocoo.org/concepts.html#the-toc-tree

best, Erik
Sent from my free software system .
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Re: [sphinx-dev] Re: Bug in epub: toctree hidden --> no text

[Erik Hetzner]

At Mon, 13 Feb 2012 12:55:21 -0800 (PST),
rolmei wrote:
> 
> Hi,
> the bugfix is in my repository at
> http://bitbucket.org/rolmei/sphinx-epub/
> 
> The fix does not add the hidden entries to the toc.ncx, I do not
> want to make a distinction between different meanings of hidden.
> The contents can nonetheless be reached by navigation to the parent
> node and pressing the next page button, following the next link, or
> by just entering the page number (if that is known).
> 
> The repository also contains new epub options/theme options for
> removing the relbar1 and footer divs, resizing the cover image and a
> fix for unsupported image types.
> 
> Roland
> 
> PS.
> I'll also create a pull request for birkenfeld/sphinx

Hi Roland,

What ebook viewer are you using? It seems that the calibre ebook
viewer uses the toc.ncx file for navigation, because when I generate
an epub with toctree :hidden: and view it in the calibre ebook-viewer,
I am unable to navigate or even turn pages.

I’m not sure what the correct behavior is here. I suppose that it
depends on the semantics of “hidden” for a toctree. I think that
perhaps content listed in the content.opf file should also be in the
toc.ncx.

best, Erik
Sent from my free software system .
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Re: [sphinx-dev] Bug in epub: toctree hidden --> no text

[Erik Hetzner]

At Sat, 28 Jan 2012 18:17:50 +0100,
Jan Ulrich Hasecke wrote:
> 
> Hi,
> 
> I want to hide the table of contents on the first page of my ebook.
> 
> """
> .. toctree::
>:maxdepth: 2
>:hidden:
> """
> 
> I can produce the html version without problems. No table of contents on
> the first page but all headlines in the sidebar as ususally.
> 
> But the epub file is empty. There is only the first page.
> 
> make runs without errors. And the size of the file is nearly the same as
> when compiled without hidden toctree.

Hi Jan,

I’ve seen this as well. What happens is that the epub builder
suppresses references to the documents listed in the toctree in the
epub’s toc.ncx as well as the  element of the content.opf
file. These documents are still included in the epub file, but they
are unreachable.

I think the correct behavior here would be for the documents to be
listed in the toc.ncx and the . They should be reachable, and
the epub contents should know about them, but the toctree should not
insert links at that point.

best, Erik
Sent from my free software system .
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Re: [sphinx-dev] Bug in epub: toctree hidden --> no text

[Erik Hetzner]

At Sat, 28 Jan 2012 21:48:16 +0100,
Jan Ulrich Hasecke wrote:
> 
> 
> 
> Am 28.01.12 20:45, schrieb Erik Hetzner:
> 
> > 
> > Hi Jan,
> > 
> > I’ve seen this as well. What happens is that the epub builder
> > suppresses references to the documents listed in the toctree in the
> > epub’s toc.ncx as well as the  element of the content.opf
> > file. These documents are still included in the epub file, but they
> > are unreachable.
> > 
> > I think the correct behavior here would be for the documents to be
> > listed in the toc.ncx and the . They should be reachable, and
> > the epub contents should know about them, but the toctree should not
> > insert links at that point.
> > 
> > best, Erik
> > 
> 
> Yes, I agree. This would be the correct behavior. Is there a already a
> bugreport?

Hi Jan,

I haven’t filed one. I didn’t know enough about sphinx to know if this
behavior made sense or not.

best, Erik
Sent from my free software system <http://fsf.org/>.
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.