Re: [sphinx-users] Sphinx-3.0.0b1 released.

[Carol Willing]

Thanks Sphinx team. The beta is working well on some of the projects that I 
tried.

Super fast builds now. Great job :D


On Tuesday, March 24, 2020 at 10:44:50 AM UTC-7, Luc Saffre wrote:
>
> I ran it on all my doctrees (more than 20), and the only "problems" were 
> duplicate glossary entries or object definitions, IOW the new version works 
> perfect for me, and better than 2.4-
>
> Thanks for your work!
>
> Luc
>
> On 22.03.20 17:26, Komiya Takeshi wrote:
>
> Hi all,
>
> We just released Sphinx-3.0.0b1.
> It has many changes including incompatible ones.
> Please confirm it working fine on your documents.
>
> In detail, please see 
> CHANGES:https://github.com/sphinx-doc/sphinx/blob/3.0.x/CHANGES
>
> You can use it with: pip install --pre Sphinx
>
> Since this is a beta release, we expect that you may encounter bugs.
> If you find a bug, please file an issue on Github 
> issues:https://github.com/sphinx-doc/sphinx/issues
>
> Thanks,
> Takeshi KOMIYA
>
>
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/b2bb0ab7-8ecd-40aa-be8f-39847999a3d8%40googlegroups.com.

[sphinx-users] Re: OT: I'm giving a talk on customizing Sphinx at PyOhio July 2018

[Carol Willing]

On Thursday, June 14, 2018 at 2:18:37 PM UTC-7, Paul Everitt wrote:
>
> I submitted a 30 min talk "Customizing Sphinx: Simple, Normal, and Hard" 
> for PyOhio next month. Just found out it was accepted. Looking forward to 
> it.
>

Congrats! You will be great. Love the docs :D 

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: can I convert markdown documentation?

[Carol Willing]

On Thursday, June 14, 2018 at 4:36:31 AM UTC-7, Renato Pontefice wrote:
>
> Hi
> I've build a little manual (about 25 pages) using the markdown language.
> All the doc are in a repository (GitHub)
> I'm wondering if is it possible to import it and use it with sphinx 
> because I want to leave markdown and start rst with sphinx.
>

As mentioned, recommonmark (likely easier if you want to keep existing 
files as markdown) or pandoc (if you wish to convert all the files at once 
to rST).

You can mix source types within Sphinx: restructured text, markdown, 
jupyter notebooks. My slidedeck from PyCon 2018 explains the basics of 
how: https://speakerdeck.com/willingc/practical-sphinx?slide=1

Thanks to all of the Sphinx contributors and maintainers too :D
 

>
> Any sudgestion?
>
> TIA
>
> Renato
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: Excluding methods from autoclass generated with autosummary

[Carol Willing]

Hi Christoph,

You have a couple of options:

1. If it is only the one function in one class, I would just let it be 
documented.

2. You could break out the builder into its own section and have 3 sections 
on the page to generate the stub files and then edit out the function 
unneeded in the builder.rst file.

3. You could try autodoc-skip-member (though I have not used it) 
http://www.sphinx-doc.org/en/stable/ext/autodoc.html#event-autodoc-skip-member

If you can you may wish to update to a more recent version of sphinx too.

Carol

On Friday, May 18, 2018 at 2:41:37 PM UTC-7, chri...@grothesque.org wrote:
>
> Hello,
>
> We are using the autosummary directive to document the contents of a 
> module [1].  Among the module contents is a class that contains some 
> members (for example [2]) that should not be documented.  (Their purpose is 
> to catch a common user error and provide a useful message.)
>
> It seems that we could use the :exclude-members: option with autoclass, 
> but if I am not mistaken that would require stopping to use autosummary for 
> module [1] and adding a bunch of files explicitly that were previously 
> generated by autosummary.  That's quite a lot of boilerplate.  Is there a 
> better solution?
>
> Thanks,
> Christoph
>
> [1] https://kwant-project.org/doc/1/reference/kwant.builder
> [2] 
> https://kwant-project.org/doc/1/reference/generated/kwant.builder.Builder#kwant.builder.Builder.modes
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: How to control auto resize of html pages?

[Carol Willing]

Perhaps try to completely uninstall sphinx and then reinstall it to see if 
the upgrade didn't get all of the source files.

On Tuesday, May 22, 2018 at 2:54:33 PM UTC-7, Reza Roodsari wrote:
>
> I have a working html build on sphinx v1.1.3 and html pages automatically 
> resize as I change the window size.
> I upgraded to sphinx 1.7.4 and after make html the page display with fixed 
> size with black background on the right. Changing the window size doesn't 
> increase the width beyond a certain max, but shrinking it will shrink the 
> size of the html page.
>
> I have nothing fancy - looking at html source the only .css files included 
> are classic.css, pygments.css, and html_style.css.
> Can anyone suggest where to look next to solve the problem?
> Thanks.
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Sphinx-1.7.0 has been released

[Carol Willing]

Congrats on the latest release. Thank you to all the contributors. It's a 
pleasure to use :-)

Warmly,

Carol

---

Carol Willing

Research Software Engineer
Project Jupyter at Cal Poly State University, San Luis Obispo


*Signature StrengthsEmpathy - Relator - Ideation - Strategic - Learner*

On Monday, February 12, 2018 at 7:25:09 AM UTC-5, Luc Saffre wrote:
>
> Thanks, Komiya, for your ongoing work. I rebuilt all my doctrees without 
> problem. (I also wrote about it in my blog 
> <http://luc.lino-framework.org/blog/2018/0212.html>)
> Luc
>
> On 12/02/18 10:01, Komiya Takeshi wrote:
>
> Hi all,
>
> I'm delighted to announce the release of Sphinx 1.7.0, now available on
> the Python package index at <http://pypi.python.org/pypi/Sphinx> 
> <http://pypi.python.org/pypi/Sphinx>.
>
> It includes about 34 new features and 31 bug fixes for the 1.6 release series.
>
> For the full changelog, go 
> to<http://www.sphinx-doc.org/en/master/changes.html> 
> <http://www.sphinx-doc.org/en/master/changes.html>.
> Thanks to all collaborators and contributers!
>
> What is it?
> ===
>
> Sphinx is a tool that makes it easy to create intelligent and beautiful
> documentation for Python projects (or other documents consisting of
> multiple reStructuredText source files).
>
> Website: http://sphinx-doc.org/
> IRC: #sphinx-doc on irc.freenode.net
>
> Enjoy!
> --
> Takeshi KOMIYA
>
>
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Separate source/build option and TOC missing document

[Carol Willing]

What are the contents of your Makefile? Link to repo would be helpful too.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: Napoleon help

[Carol Willing]

Hi Mike,

Jupyter uses napoleon in some of our docs. JupyterHub is one example. We 
more often use NumPy docstring format than Google.

If the project is open source, please send a link to your project. I would 
be happy to try to build.

Carol

---

Carol Willing

Research Software Engineer
Project Jupyter at Cal Poly State University, San Luis Obispo
@willingc on GitHub and @willingcarol on Twitter
willi...@gmail.com and cawil...@calpoly.edu


*Signature StrengthsEmpathy - Relator - Ideation - Strategic - Learner*

On Thursday, September 28, 2017 at 5:34:04 PM UTC-7, mrb...@lanl.gov wrote:
>
> We're currently expanding a python development project and would like to 
> use Sphinx and the Napoleon extension to generate html documentation.  
> We've tried both Sphinx 1.4.1 and 1.7, and all we're getting is a copy of 
> the source code (and comments) in an html wrapper.  I don't see any errors 
> when we run 'make html'.  Are there some examples of python files with 
> Google docs markup AND the expected html output (screen shot is fine) 
> available?  Also are there any open source projects that are using the 
> Napoleon extension with python source files that we could use as a detailed 
> example?  We did modify the config.py to use sphinx.ext.napoleon.  We were 
> expecting some of amount of formatting in the html output, based on the 
> comment markup.  Thanks, Mike.
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Intersphinx for links among our own projects?

[Carol Willing]

Hi Dave,

I would be interested in your two round build script if you wish to share 
it :-)

I have about 30 some repos across 3 organizations that would really benefit 
from any tips/tools that simplifies linking between them on RTD.

Thanks,

Carol

On Sunday, April 10, 2016 at 5:44:48 PM UTC-7, Dave Dittrich wrote:
>
> I wanted to bump this question back up. Has anyone else come up with a 
> good way to handle arbitrary intersphinx links between docs that are 
> to be hosted on readthedocs? Forcing a "no circular links" policy 
> imposes significant restrictions on structuring multiple Git repos 
> that are related. My solution was a script that does two-round builds, 
> but has to build the docs such that both stages are done on the final 
> resting place. An option to control the URL and centralize the 
> inventory files with unique names (rather than requiring the URL path 
> have the repo name just so that the inventory can always have the name 
> "objects.inv", is also restrictive - could this not have the repo's 
> name as the base instead of "objects"?) 
>
> On Sat, Jan 23, 2016 at 6:42 PM, Ned Batchelder  > wrote: 
> > Thanks, this is a way to do it, though it will be expensive in time. 
>  Thanks 
> > for the feedback, at least I know I haven't overlooked something that's 
> > available. 
> > 
> > --Ned. 
> > 
> > On Friday, January 22, 2016 at 5:59:31 PM UTC-5, Daniel Beck wrote: 
> >> 
> >> Hi Ned, 
> >> 
> >> I've had this problem myself. If you build a given Sphinx project 
> pointing 
> >> to a not yet built .inv file (or files), Sphinx will issue a bunch of 
> >> warnings (e.g., `WARNING: intersphinx inventory 
> >> '../path_to_other_project/objects.inv' not fetchable` ) but Sphinx will 
> >> build the project's own .inv file successfully. So I do a two-pass 
> build 
> >> that ignores warnings on the first pass and ignores the saved 
> environment on 
> >> the second pass. It looks a bit like this (though there's an 
> overcomplicated 
> >> fabfile to do this all for me): 
> >> 
> >> For each project, first pass, ignoring warnings: 
> >> > make SPHINXOPTS='-Q' html 
> >> 
> >> For each project, second pass (or more, if you're building additional 
> >> formats): 
> >> > make SPHINXOPTS='-E -n -W' html 
> >> 
> >> `-E` is the important part, forcing Sphinx to refetch the .inv file(s). 
> I 
> >> like to use `-n` for nitpicky mode and `-W` to promote warnings to 
> errors, 
> >> since I expect warnings in the first pass but would rather not have the 
> >> build succeed at all if there are unexpected warnings (your 
> preferences—and 
> >> authorial discipline—may vary). 
> >> 
> >> You might also want to add `-q` because seeing the build progress over 
> and 
> >> over gets old fast. 
> >> 
> >> A dedicated inventory builder would be nice to have, but this gets the 
> job 
> >> done for me. I hope it helps solve your problem! 
> >> 
> >> 
> >> —Daniel 
> >> 
> >> 
> >> On Fri, Jan 22, 2016 at 5:30 PM, Ned Batchelder  
>
> >> wrote: 
> >>> 
> >>> At edX, we're using intersphinx to link among our own projects.  But 
> it's 
> >>> designed to pull .inv files from readthedocs.  This means if we add a 
> new 
> >>> reference between projects, the build will fail until the target has 
> been 
> >>> published.  I tried using the second value in the mapping tuple to 
> point to 
> >>> a local file, but the file hadn't been created yet. 
> >>> 
> >>> Is there a way to generate all the .inv files in a first pass, and 
> then 
> >>> do the full build of the doc? 
> >>> 
> >>> --Ned. 
> >>> 
> >>> -- 
> >>> You received this message because you are subscribed to the Google 
> Groups 
> >>> "sphinx-users" group. 
> >>> To unsubscribe from this group and stop receiving emails from it, send 
> an 
> >>> email to sphinx-users...@googlegroups.com. 
> >>> To post to this group, send email to sphinx...@googlegroups.com. 
> >>> Visit this group at https://groups.google.com/group/sphinx-users. 
> >>> For more options, visit https://groups.google.com/d/optout. 
> >> 
> >> 
> > -- 
> > You received this message because you are subscribed to the Google 
> Groups 
> > "sphinx-users" group. 
> > To unsubscribe from this group and stop receiving emails from it, send 
> an 
> > email to sphinx-users...@googlegroups.com . 
> > To post to this group, send email to sphinx...@googlegroups.com 
> . 
> > Visit this group at https://groups.google.com/group/sphinx-users. 
> > For more options, visit https://groups.google.com/d/optout. 
>
>
>
> -- 
> Dave Dittrich 
> dave.d...@gmail.com  
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: Sphinx 1.4.1 released

[Carol Willing]

Congrats on the release. Thanks to all who contributed. The 1.4 release 
series has worked really well for us.

Warmly,
Carol

On Friday, April 15, 2016 at 9:39:05 PM UTC-7, Takayuki SHIMIZUKAWA wrote:
>
> Hi all,
>
> I'm delighted to announce the release of Sphinx 1.4.1, now available on
> the Python package index at .
>
> It includes about 13 bug fixes for the 1.4 release series, among them a
> incompatibility and a packaging error.
>
> For the full changelog, go to <
> http://www.sphinx-doc.org/en/stable/changes.html>.
> Thanks to all collaborators and contributers!
>
> What is it?
> ===
>
> Sphinx is a tool that makes it easy to create intelligent and beautiful
> documentation for Python projects (or other documents consisting of
> multiple reStructuredText source files).
>
> Website: http://sphinx-doc.org/
> IRC: #sphinx-doc on irc.freenode.net
>
> Enjoy!
> --
> Takayuki SHIMIZUKAWA
> http://about.me/shimizukawa
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: Table of Contents formatting

[Carol Willing]

Hi Matt,

Check out the info on html_sidebars in the Sphinx docs for the 
configuration file (conf.py). You can also change the theme using 
"html_theme" in the same file. Additional information about built in themes 
are found 
here http://www.sphinx-doc.org/en/stable/theming.html#builtin-themes

The matplotlib project has a tutorial that you may find helpful too 
(http://matplotlib.org/sampledoc/index.html).

Good luck!

Carol


On Monday, February 8, 2016 at 5:39:08 PM UTC-8, Matthew Gilbert wrote:
>
> Hi,
>
> This seems like a fairly simple question but I've searched SO and the 
> sphinx documentation and can't seem to find out how to do this. I was 
> wondering how to include a table of contents on every page (on the left 
> hand side), and have this include only the names of the top level page.  
> Let's say my project looks like
>
> index.rst
> test.rst
>
> where index.rst is as follows
>
> .. test documentation master file, created by
>sphinx-quickstart on Mon Feb  8 18:05:39 2016.
>You can adapt this file completely to your liking, but it should at 
> least
>contain the root `toctree` directive.
>
> Welcome to test's documentation!
> 
>
> Contents:
>
> .. toctree::
>:titlesonly:
>
>test
>
> More stuff
> ==
>
> and test.rst
>
> Hello
> =
>
> This is a test
>
> I would like the Table of Contents on the left hand side to look like
>
> Welcome to test’s documentation!
> Hello
>
> and this to be present on every page, however I can't seem to find any way 
> to do this. An example of a site that does this is 
> https://wiki.fysik.dtu.dk/ase/
>
> Any help or linking to relevant documentation would be much appreciated.
>
> Regards,
> -Matt
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.