Re: [sphinx-dev] Possible to break a title across two lines?
I was also wondering about exactly the same thing yesterday. I, in fact, sent an email to the group but did not see that email reach the group. Anyhow, is it possible to increase the text size in addition to using strong emphasis? Thanks. On Thu, Jan 13, 2011 at 2:34 AM, Georg Brandl ge...@python.org wrote: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 22:21, schrieb Kevin Cole: Hi, I haven't been fooling w/ Sphinx or reST very long, and don't know LaTeX. I'm currently running Sphinx 1.0.1 under Ubuntu Maverick. I've tried a few different ways to get a document subtitle, but in LaTeX, it interprets the subtitle as a section heading. Not what I want at all. Ideally, I'd want a line of text in a large font, followed immediately by text in a smaller font. But I could probably live w/ two lines of equally large fonts. Hi Kevin, it's not possible with either rST or LaTeX to break a title in two lines. What you could do is to just use strong emphasis: Title = **Subtitle** Georg -- 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] Two newbie questions
You can create a custom theme and/or put a CSS file to _static to modify the HTML output. Themes can inherit from each other so you don't have to reinvent everything. -- 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] Add Sphinx project
The Python 3.1 versio of my Hands-on Python Tutorial uses Sphinx for both the html and pdf versions. http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/ http://anh.cs.luc.edu/python/hands-on/3.1/Hands-onPythonTutorial.pdf Feel free to add to your project list. -- 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] Two newbie questions
2011/1/13 Curiouslearn curiousle...@gmail.com Hello All, Sphinx seems great. I am trying it out and I think I will start using it for most of my writing. I have two basic questions: (1) How to get rid of the text v0.1 or something like that which refers to the version. I am writing some notes and it is not a documentation about any software. I commented out version = 0.1 in the conf.py file and then I just got a v. In your conf.py you should specify html_title. Search this paragraph: # The name for this set of Sphinx documents. If None, it defaults to # project vrelease documentation. #html_title = None -- 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] Possible to break a title across two lines?
@TP Thanks! If you don't mind, can you send me an example of your subtitle css. Also, did you save it in _static. Does one need both container and class directives to do this? Thanks for your patience. On Thu, Jan 13, 2011 at 7:28 AM, TP wing...@gmail.com wrote: On Thu, Jan 13, 2011 at 2:07 AM, Curiouslearn curiousle...@gmail.com wrote: I was also wondering about exactly the same thing yesterday. I, in fact, sent an email to the group but did not see that email reach the group. Anyhow, is it possible to increase the text size in addition to using strong emphasis? Thanks. On Thu, Jan 13, 2011 at 2:34 AM, Georg Brandl ge...@python.org wrote: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 22:21, schrieb Kevin Cole: Hi, I haven't been fooling w/ Sphinx or reST very long, and don't know LaTeX. I'm currently running Sphinx 1.0.1 under Ubuntu Maverick. I've tried a few different ways to get a document subtitle, but in LaTeX, it interprets the subtitle as a section heading. Not what I want at all. Ideally, I'd want a line of text in a large font, followed immediately by text in a smaller font. But I could probably live w/ two lines of equally large fonts. Hi Kevin, it's not possible with either rST or LaTeX to break a title in two lines. What you could do is to just use strong emphasis: Title = **Subtitle** Georg -- 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. For HTML generation, I did something like this by doing: === My Normal Title === .. container:: :class: subtitle This is My Very Long Subtitle |BR| That Spans Two Lines By Using a br / .. |BR| replace:: :raw-html:`br /` and creating a custom CSS style for my new subtitle class to make its font larger than normal. Maybe you can do something similar for LaTeX? -- 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. -- 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] how to share documents created using Sphinx (html version)
Hello All, Two questions about sharing Sphinx documentation with others: (1) Do you know of an easy way of private hosting of Sphinx documents online (where you can restrict access to it)? Is there a web host or some solution that makes this possible easily? (2) If I want to email the documentation to someone, which files do I need to email? Do I need to send _build, _template and _static directories. Does the recipient need to have Python? Thanks, Bharat -- 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] Possible to break a title across two lines?
On Thu, Jan 13, 2011 at 9:35 AM, Curiouslearn curiousle...@gmail.com wrote:
@TP Thanks! If you don't mind, can you send me an example of your
subtitle css. Also, did you save it in _static.
in my conf.py file I have:
html_theme = 'customtheme'
html_theme_path = ['.']
in my customtheme\static\customtheme.css_t file i have (along with a
bunch of other stuff):
@import url(default.css);
div.container.subtitle {
font-size: 160%;
font-family: sans-serif;
font-weight: normal;
margin-bottom: 0.5em;
}
(This makes sure that *only* div's that have both container
subtitle class names will be affected)
Does one need both
container and class directives to do this?
Given the following in a .rst file:
.. container::
:class: subtitle
container is the standard docutils directive documented at
http://docutils.sourceforge.net/docs/ref/rst/directives.html#container.
:class: is an option for that directive. It generates something
like the following HTML:
div class=class subtitle container
This is My Very Long Subtitle span class=raw-htmlbr //span
That Spans Two Lines By Using a lt;br /gt;
/div
After rereading the above mentioned documentation on container, I
see that I should probably have done the following:
.. container:: subtitle
Which generates the clearer:
div class=subtitle container
Thanks for your patience.
On Thu, Jan 13, 2011 at 7:28 AM, TP wing...@gmail.com wrote:
On Thu, Jan 13, 2011 at 2:07 AM, Curiouslearn curiousle...@gmail.com wrote:
I was also wondering about exactly the same thing yesterday. I, in
fact, sent an email to the group but did not see that email reach the
group.
Anyhow, is it possible to increase the text size in addition to using
strong emphasis?
Thanks.
On Thu, Jan 13, 2011 at 2:34 AM, Georg Brandl ge...@python.org wrote:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 12.01.2011 22:21, schrieb Kevin Cole:
Hi,
I haven't been fooling w/ Sphinx or reST very long, and don't know LaTeX.
I'm
currently running Sphinx 1.0.1 under Ubuntu Maverick.
I've tried a few different ways to get a document subtitle, but in LaTeX,
it
interprets the subtitle as a section heading. Not what I want at all.
Ideally,
I'd want a line of text in a large font, followed immediately by text in a
smaller font. But I could probably live w/ two lines of equally large
fonts.
Hi Kevin,
it's not possible with either rST or LaTeX to break a title in two lines.
What you could do is to just use strong emphasis:
Title
=
**Subtitle**
Georg
--
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.
For HTML generation, I did something like this by doing:
===
My Normal Title
===
.. container::
:class: subtitle
This is My Very Long Subtitle |BR| That Spans Two Lines
By Using a br /
.. |BR| replace:: :raw-html:`br /`
and creating a custom CSS style for my new subtitle class to make
its font larger than normal. Maybe you can do something similar for
LaTeX?
--
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.
--
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.
--
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] how to share documents created using Sphinx (html version)
On Thu, Jan 13, 2011 at 11:18 AM, Curiouslearn curiousle...@gmail.com wrote: Hello All, Two questions about sharing Sphinx documentation with others: (1) Do you know of an easy way of private hosting of Sphinx documents online (where you can restrict access to it)? Is there a web host or some solution that makes this possible easily? (2) If I want to email the documentation to someone, which files do I need to email? Do I need to send _build, _template and _static directories. Does the recipient need to have Python? Thanks, Bharat -- 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. All you have to do is copy the contents of the _build/html directory tree to your web host or email it to someone (You can skip the .buildinfo objects.inv files if you want). The _static directory is automatically copied to _build/html/_static as are the processed template files (.css_t files get converted to .css files). It's up to your website configuration as to whether those pages are private or not. Recipients only need a web browser to view Sphinx generated HTML pages. -- 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] Two newbie questions
On Thu, Jan 13, 2011 at 9:32 AM, Curiouslearn curiousle...@gmail.com wrote:
@Federico: Thanks so much. This is great.
@Daslch: Thanks. Do I just save my css file in the _static directory
and then invoke the styles I define there using raw html directive.
Thanks again.
Here's what I do. In my conf.py file I set:
html_theme = 'customtheme'
html_theme_path = ['.']
rst_prolog=
.. role:: myrole
:class: mycustomrole
My customtheme\theme.conf contains:
[theme]
inherit = default
stylesheet = customtheme.css
pygments_style = sphinx
and customtheme\static\customtheme.css_t contains:
@import url(default.css);
.mycustomrole {
font-family: monospace;
font-size: 125%;
}
if for example I want all myrole text to be monospace and bigger.
In my .rst files I can then do:
Some text that uses :myrole:`my custom role`.
and when Sphinx generates the HTML it will look like:
link rel=stylesheet href=../_static/customtheme.css type=text/css /
...
pSome text that uses span class=mycustomrolemy custom role/span./p
So, as you can see there is rarely any need to use the :raw-html: role.
On Thu, Jan 13, 2011 at 10:06 AM, Federico Bruni fedel...@gmail.com wrote:
2011/1/13 Curiouslearn curiousle...@gmail.com
Hello All,
Sphinx seems great. I am trying it out and I think I will start using
it for most of my writing. I have two basic questions:
(1) How to get rid of the text v0.1 or something like that which
refers to the version. I am writing some notes and it is not a
documentation about any software. I commented out version = 0.1 in
the conf.py file and then I just got a v.
In your conf.py you should specify html_title.
Search this paragraph:
# The name for this set of Sphinx documents. If None, it defaults to
# project vrelease documentation.
#html_title = None
--
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.
--
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.
--
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] Two newbie questions
@TP Thanks for this example. I will read it carefully. This should be
really helpful. Thanks again.
On Thu, Jan 13, 2011 at 3:56 PM, TP wing...@gmail.com wrote:
On Thu, Jan 13, 2011 at 9:32 AM, Curiouslearn curiousle...@gmail.com wrote:
@Federico: Thanks so much. This is great.
@Daslch: Thanks. Do I just save my css file in the _static directory
and then invoke the styles I define there using raw html directive.
Thanks again.
Here's what I do. In my conf.py file I set:
html_theme = 'customtheme'
html_theme_path = ['.']
rst_prolog=
.. role:: myrole
:class: mycustomrole
My customtheme\theme.conf contains:
[theme]
inherit = default
stylesheet = customtheme.css
pygments_style = sphinx
and customtheme\static\customtheme.css_t contains:
@import url(default.css);
.mycustomrole {
font-family: monospace;
font-size: 125%;
}
if for example I want all myrole text to be monospace and bigger.
In my .rst files I can then do:
Some text that uses :myrole:`my custom role`.
and when Sphinx generates the HTML it will look like:
link rel=stylesheet href=../_static/customtheme.css type=text/css /
...
pSome text that uses span class=mycustomrolemy custom role/span./p
So, as you can see there is rarely any need to use the :raw-html: role.
On Thu, Jan 13, 2011 at 10:06 AM, Federico Bruni fedel...@gmail.com wrote:
2011/1/13 Curiouslearn curiousle...@gmail.com
Hello All,
Sphinx seems great. I am trying it out and I think I will start using
it for most of my writing. I have two basic questions:
(1) How to get rid of the text v0.1 or something like that which
refers to the version. I am writing some notes and it is not a
documentation about any software. I commented out version = 0.1 in
the conf.py file and then I just got a v.
In your conf.py you should specify html_title.
Search this paragraph:
# The name for this set of Sphinx documents. If None, it defaults to
# project vrelease documentation.
#html_title = None
--
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.
--
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.
--
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.
--
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] attributes inside autoclass
Hi All, When I do, for example: .. autoclass:: TempDirectory :members: .. attribute:: path This is the path attribute ...the attribute isn't shown in the rendered html. Why is that? cheers, Chris -- Simplistix - Content Management, Batch Processing Python Consulting - http://www.simplistix.co.uk -- 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] classes inside automodule
Hi All, If I do, for example: .. automodule:: testfixtures .. class:: Comparison ...then I end up with two sections for the Comparison class, one auto-generated and one with my manual bits. I thought the manual one was supposed to override the automated one? cheers, Chris PS: This and the other message I just posted on with Sphinx 1.0.6 -- Simplistix - Content Management, Batch Processing Python Consulting - http://www.simplistix.co.uk -- 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] how to share documents created using Sphinx (html version)
Transferring just the _build/html directory works best except that the math does not compile. I am using Mathjax extension. It shows fine on my computer but not on my personal website. Everything else (like the links, search seem to work) Can someone please help? Thanks. Best, Bharat On Thu, Jan 13, 2011 at 5:01 PM, Curiouslearn curiousle...@gmail.com wrote: @TP Thanks so much for all your responses. Really appreciate it. On Thu, Jan 13, 2011 at 3:27 PM, TP wing...@gmail.com wrote: On Thu, Jan 13, 2011 at 11:18 AM, Curiouslearn curiousle...@gmail.com wrote: Hello All, Two questions about sharing Sphinx documentation with others: (1) Do you know of an easy way of private hosting of Sphinx documents online (where you can restrict access to it)? Is there a web host or some solution that makes this possible easily? (2) If I want to email the documentation to someone, which files do I need to email? Do I need to send _build, _template and _static directories. Does the recipient need to have Python? Thanks, Bharat -- 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. All you have to do is copy the contents of the _build/html directory tree to your web host or email it to someone (You can skip the .buildinfo objects.inv files if you want). The _static directory is automatically copied to _build/html/_static as are the processed template files (.css_t files get converted to .css files). It's up to your website configuration as to whether those pages are private or not. Recipients only need a web browser to view Sphinx generated HTML pages. -- 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. -- 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] how to share documents created using Sphinx (html version)
On Thu, Jan 13, 2011 at 17:54, Curiouslearn curiousle...@gmail.com wrote: Transferring just the _build/html directory works best except that the math does not compile. I am using Mathjax extension. It shows fine on my computer but not on my personal website. Everything else (like the links, search seem to work) Hi Bharat, MathJax has a large overhead (around 100Mb) to transfer. I host a free MathJax installation - read more about it at http://mathjax.connectmv.com Basically all you need to do is set in your Sphinx ``conf.py`` that: mathjax_path = 'http://mathjax.connectmv.com/MathJax.js' and as long as you have an internet connection you don't need to worry about the MathJax files. Otherwise, you will need to copy them along with your HTML. The other option is, of course, to use the PNG math extension, which will create small PNG files that go with your HTML. Kevin Can someone please help? Thanks. Best, Bharat On Thu, Jan 13, 2011 at 5:01 PM, Curiouslearn curiousle...@gmail.com wrote: @TP Thanks so much for all your responses. Really appreciate it. On Thu, Jan 13, 2011 at 3:27 PM, TP wing...@gmail.com wrote: On Thu, Jan 13, 2011 at 11:18 AM, Curiouslearn curiousle...@gmail.com wrote: Hello All, Two questions about sharing Sphinx documentation with others: (1) Do you know of an easy way of private hosting of Sphinx documents online (where you can restrict access to it)? Is there a web host or some solution that makes this possible easily? (2) If I want to email the documentation to someone, which files do I need to email? Do I need to send _build, _template and _static directories. Does the recipient need to have Python? Thanks, Bharat -- 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. All you have to do is copy the contents of the _build/html directory tree to your web host or email it to someone (You can skip the .buildinfo objects.inv files if you want). The _static directory is automatically copied to _build/html/_static as are the processed template files (.css_t files get converted to .css files). It's up to your website configuration as to whether those pages are private or not. Recipients only need a web browser to view Sphinx generated HTML pages. -- 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. -- 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. -- 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] how to share documents created using Sphinx (html version)
Kevin, thanks for writing the Mathjax extension. I changed the path to your suggestion below. It now works great. Thanks. On Thu, Jan 13, 2011 at 6:01 PM, Kevin Dunn kgd...@gmail.com wrote: On Thu, Jan 13, 2011 at 17:54, Curiouslearn curiousle...@gmail.com wrote: Transferring just the _build/html directory works best except that the math does not compile. I am using Mathjax extension. It shows fine on my computer but not on my personal website. Everything else (like the links, search seem to work) Hi Bharat, MathJax has a large overhead (around 100Mb) to transfer. I host a free MathJax installation - read more about it at http://mathjax.connectmv.com Basically all you need to do is set in your Sphinx ``conf.py`` that: mathjax_path = 'http://mathjax.connectmv.com/MathJax.js' and as long as you have an internet connection you don't need to worry about the MathJax files. Otherwise, you will need to copy them along with your HTML. The other option is, of course, to use the PNG math extension, which will create small PNG files that go with your HTML. Kevin Can someone please help? Thanks. Best, Bharat On Thu, Jan 13, 2011 at 5:01 PM, Curiouslearn curiousle...@gmail.com wrote: @TP Thanks so much for all your responses. Really appreciate it. On Thu, Jan 13, 2011 at 3:27 PM, TP wing...@gmail.com wrote: On Thu, Jan 13, 2011 at 11:18 AM, Curiouslearn curiousle...@gmail.com wrote: Hello All, Two questions about sharing Sphinx documentation with others: (1) Do you know of an easy way of private hosting of Sphinx documents online (where you can restrict access to it)? Is there a web host or some solution that makes this possible easily? (2) If I want to email the documentation to someone, which files do I need to email? Do I need to send _build, _template and _static directories. Does the recipient need to have Python? Thanks, Bharat -- 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. All you have to do is copy the contents of the _build/html directory tree to your web host or email it to someone (You can skip the .buildinfo objects.inv files if you want). The _static directory is automatically copied to _build/html/_static as are the processed template files (.css_t files get converted to .css files). It's up to your website configuration as to whether those pages are private or not. Recipients only need a web browser to view Sphinx generated HTML pages. -- 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. -- 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. -- 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. -- 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] classes inside automodule
On Thu, Jan 13, 2011 at 2:33 PM, Chris Withers ch...@simplistix.co.uk wrote: Hi All, If I do, for example: .. automodule:: testfixtures .. class:: Comparison ...then I end up with two sections for the Comparison class, one auto-generated and one with my manual bits. I thought the manual one was supposed to override the automated one? I don't think so. Did you try the exclude-members option at http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule ? cheers, Chris PS: This and the other message I just posted on with Sphinx 1.0.6 -- Simplistix - Content Management, Batch Processing Python Consulting - http://www.simplistix.co.uk -- 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. -- 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.
