def construct_response(exit_code: int, message: str) -> Response:
>> """
>> Construct a Flask-suitable response
>>
>> :param exit_code: 0 or something else
>> :param message: something useful
>> :return: a Flask-suitable response
>> """
>>
>>
>> @app.route(f"/{version}/", me
And I can answer my own Question 2:
:func:`my_project.main_application.construct_response`
On Mon, Aug 28, 2023 at 1:39 PM Jason Friedman wrote:
> def construct_response(exit_code: int, message: str) -> Response:
>> """
>> Construct a Flask-suitable response
>>
>> :param exit_code: 0
>
> def construct_response(exit_code: int, message: str) -> Response:
> """
> Construct a Flask-suitable response
>
> :param exit_code: 0 or something else
> :param message: something useful
> :return: a Flask-suitable response
> """
>
>
> @app.route(f"/{version}/", methods=
I have two questions, please (this is after reading
https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html#automatically-label-sections
).
This is my project structure:
my_project
api
stuff1.py
stuff2.py
lib
stuff3.py
stuff4.py
main_application.py
On 05/18/2020 09:46 AM, Kale Kundert wrote:
I'm writing to share a Sphinx plugin I wrote, which I think makes the
documentation for large classes much easier to navigate and understand. The
plugin is called `autoclasstoc` and you can find the documentation here:
I'm writing to share a Sphinx plugin I wrote, which I think makes the
documentation for large classes much easier to navigate and understand. The
plugin is called `autoclasstoc` and you can find the documentation here:
https://autoclasstoc.readthedocs.io/en/latest/
I wrote this plugin be
@ThomasJollans
was supposed to detect errors in trabslation format such as the famous miss
of éspace insécable etc, not conformed to sphinx notation
e.g.
if i put an extra space between the : and `
:meth: `some_meth`
Abdur-Rahmaan Janhangeer
https://github.com/Abdur-rahmaanJ
Mauritius
On 22/07/18 05:24, Abdur-Rahmaan Janhangeer wrote:
> normally when you use make with sphinx, it should build and tell you errors
> (so that reviewers don't have to correct it manually) i have been doing
> some contribs to french docs translation but my make is a bit craz
normally when you use make with sphinx, it should build and tell you errors
(so that reviewers don't have to correct it manually) i have been doing
some contribs to french docs translation but my make is a bit crazy :
https://www.pythonmembers.club/wp-content/uploads/2018/07/make-win.png
Hi there,
we are evaluating the possibility to use Sphinx and rst to document our
projects. What we have is a project structure that would look like this:
./sandbox/project/
├── components
│ ├── module1
│ │ ├── doc
│ │ │ └── module1.rst
│ │ └── src
│ └── module2
│ ├── doc
bs expanded to 4
> >> columns, and we use 120 columns total width (and sometimes a little
> >> more :).
>
> >> Is there any good way of making Sphinx use 4 column tabs and 120 column
> >> text?
>
> > Are you sure your tabs are being changed to eight
> more :).
>> Is there any good way of making Sphinx use 4 column tabs and 120 column text?
> Are you sure your tabs are being changed to eight spaces? It's possible they
> are still tabs in the browser, and the browser is choosing to display them
> as eight spaces. If that&
On Monday, October 24, 2016 at 5:00:47 PM UTC-4, Dan Stromberg wrote:
> Hi folks.
>
> I'm attempting to set up Sphinx to document several API's based on docstrings.
>
> I've got something browseable for one example API using Sphinx +
> autodoc + apidoc.
>
>
On Sat, Sep 24, 2016 at 6:30 PM, Yann Kaiser wrote:
> pydoctor may be something you're looking for. I don't know if it supports
> exporting to PDF like Sphinx does.
>
> As you've no doubt figured out by now, Sphinx doesn't revolve around the
> Python files t
Hi folks.
I'm attempting to set up Sphinx to document several API's based on docstrings.
I've got something browseable for one example API using Sphinx +
autodoc + apidoc.
However, we aren't really a PEP8 shop; we use hard tabs expanded to 4
columns, and we use 120 colu
On 09/25/2016 03:20 AM, chitt...@uah.edu wrote:
On Sunday, September 11, 2016 at 3:56:36 PM UTC-5, chit...@uah.edu wrote:
(about being frustrated with sphinx)
I _remain_ frustrated - even as I finally figured out how to use it (thanks to
a complete example from a friend)
sphinx is very picky
pydoctor may be something you're looking for. I don't know if it supports
exporting to PDF like Sphinx does.
As you've no doubt figured out by now, Sphinx doesn't revolve around the
Python files themselves, but rather .rst files in which you can indeed
instruct Sphinx to ju
On Sunday, September 11, 2016 at 3:56:36 PM UTC-5, chit...@uah.edu wrote:
(about being frustrated with sphinx)
I _remain_ frustrated - even as I finally figured out how to use it (thanks to
a complete example from a friend)
sphinx is very picky about spaces, lines - I had a line with some math
Excuse me for being frustrated (!) (with documenting python with Sphinx)
I have a source file myfile.py which contains
documentation with "docstrings"
I am trying to have Sphinx create the pdf (from latex)
I have run through sphinx-quickstart - which creates
build, source (the
On 2016-04-04 01:26, George Trojan wrote:
Yet another sphinx question. I am a beginner here.
I can't make sphinx to recognize the following (abbreviated) code:
'''
module description
:func:`~pipe` and :func:`~spipe` read data passed by LDM's `pqact`.
''&
Yet another sphinx question. I am a beginner here.
I can't make sphinx to recognize the following (abbreviated) code:
'''
module description
:func:`~pipe` and :func:`~spipe` read data passed by LDM's `pqact`.
'''
def _pipe(f, *args):
'
> Subject: Re: A tool to add diagrams to sphinx docs
> From: irmen.nos...@xs4all.nl
> Date: Fri, 1 Apr 2016 18:26:48 +0200
> To: python-list@python.org
>
> On 1-4-2016 17:59, George Trojan - NOAA Federal wrote:
> > What graphics editor would you recommend to cre
On 1-4-2016 17:59, George Trojan - NOAA Federal wrote:
> What graphics editor would you recommend to create diagrams that can be
> included in sphinx made documentation? In the past I used xfig, but was not
> happy with font quality. My understanding is the diagrams would be saved in
>
What graphics editor would you recommend to create diagrams that can be
included in sphinx made documentation? In the past I used xfig, but was not
happy with font quality. My understanding is the diagrams would be saved in
a .png file and I should use an image directive in the relevant .rst file
> To: python-list@python.org
> From: tjre...@udel.edu
> Subject: Re: Screenshots in Sphinx docs
> Date: Mon, 14 Dec 2015 14:01:03 -0500
>
> On 12/14/2015 11:31 AM, Albert-Jan Roskam wrote:
>
> > I'd like to include up-to-date screenshots (of a tkinter app)
&
On 12/14/2015 11:31 AM, Albert-Jan Roskam wrote:
I'd like to include up-to-date screenshots (of a tkinter app)
> into my Sphinx documentation.
If you manually take screenshots with *any* screen grabber and save in
an appropriate format, this is apparently trivial -- use the
Hello,
I'd like to include up-to-date screenshots (of a tkinter app) into my Sphinx
documentation. This looks ok:
https://pypi.python.org/pypi/sphinxcontrib-programscreenshot
BUT I need something that works on Windows (Python 2.7). Can any recommend an
approach? I thought about using PIL:
(Sorry for top-posting, mobile hotmail sie sucks). This is cool, although it's
not a Sphinx directive. You use insert the resulting graph in the .rst of
course:
http://furius.ca/snakefood/
Date: Fri, 2 Oct 2015 11:14:59 -0300
Subject: I'm using Sphinx, but is there a UML auto gene
> You can use Graphvix and Plant UML from inside Sphinx.
> http://build-me-the-docs-please.readthedocs.org/en/latest/Using_Sphinx/UsingGraphicsAndDiagramsInSphinx.html
>
> Laura
>
Keep this in mind: However you write your docs, they should be
accessible for everyone to use.
In a message of Fri, 02 Oct 2015 11:14:59 -0300, Gilcan Machado writes:
>Hi,
>
>I'm using Sphinx as a doc tool.
>
>Amazing.
>
>But I need a way to describe, for example, that, inside a Person class,
>there's a method called changePassword which depen
Hi,
I'm using Sphinx as a doc tool.
Amazing.
But I need a way to describe, for example, that, inside a Person class,
there's a method called changePassword which depends of the execution of
the method checkPermissions, and checkPermissions depends on the execution
of two other met
On 2015-09-18, John Wong wrote:
> if you are okay with cloning a huge repository then I don't see a problem.
Ah yes, if the repository got cloned a lot that would be a problem.
The repository in question doesn't get cloned (it does get backed up).
As I mentioned, it's subversion. Subversion is
On Fri, Sep 18, 2015 at 2:50 AM, Peter Otten <__pete...@web.de> wrote:
> Ben Finney wrote:
>
> > David Aldrich writes:
> >
> >> I have setup Sphinx for my Python project. We keep all our code and
> >> documentation in Subversion.
> >
&g
David Aldrich wrote:
> I have setup Sphinx for my Python project. We keep all our code and
> documentation in Subversion. So, following changes to the Python code, I
> need to regenerate and commit the Sphinx generated documentation.
>
> I just wondered how people manage this.
Ben Finney wrote:
> David Aldrich writes:
>
>> I have setup Sphinx for my Python project. We keep all our code and
>> documentation in Subversion.
>
> It's a good idea to keep *source* files in VCS.
>
> It's a bad idea to keep automatically-generated f
On Fri, Sep 18, 2015 at 9:37 AM, Ben Finney wrote:
> David Aldrich writes:
>
>> I have setup Sphinx for my Python project. We keep all our code and
>> documentation in Subversion.
>
> It's a good idea to keep *source* files in VCS.
>
> It's a bad idea to k
On 2015-09-17, Ben Finney wrote:
> The VCS should track only those files that humans edit directly.
While I agree that files automatically generated shouldn't be checked
in to a VCS, I'm in favor of putting key binary files under VCS if
they are required to do the build. We often check deveopme
David Aldrich writes:
> I have setup Sphinx for my Python project. We keep all our code and
> documentation in Subversion.
It's a good idea to keep *source* files in VCS.
It's a bad idea to keep automatically-generated files in VCS; it's
especially bad to do so if they
--command='make html'
change to .rst if that is what your Sphinx docs make, etc.
--
https://mail.python.org/mailman/listinfo/python-list
Hi
I have setup Sphinx for my Python project. We keep all our code and
documentation in Subversion. So, following changes to the Python code, I need
to regenerate and commit the Sphinx generated documentation.
I just wondered how people manage this. I'm thinking of using Jenki
also noticed the
references to vcvars. I was installing it from a shell where vcvars
are enabled. I tried to install sphinx from a fresh clean shell and it
went smoothly this time.
Thanks.
--
https://mail.python.org/mailman/listinfo/python-list
On 03/03/2015 05:55, Mario Figueiredo wrote:
Anyone else having problems installing Sphinx as of late? It installed
perfectly fine for me under windows just a few weeks ago. But
currently I get an error when trying to install it:
I'm including the full error output.
$ pip install -U s
Anyone else having problems installing Sphinx as of late? It installed
perfectly fine for me under windows just a few weeks ago. But
currently I get an error when trying to install it:
I'm including the full error output.
$ pip install -U sphinx --no-cache-dir
Collecting sphinx
Downlo
On Tue, 17 Feb 2015 00:55:29 +0100, Mario Figueiredo
wrote:
>
>What am I missing in order to get item.py properly parsed by sphinx?
Nevermind. I found the problem. In order to document the source code
it needs to be used in conjunction with sphinx-apidoc.
--
https://mail.python.org/m
Hello all,
I'm at loss as to how properly setup sphinx to document my code.
Getting a bit frustrated since I read everywhere it is an easy tool to
use, but I'm either too dumb or I'm missing something very obvious.
I setup sphinx with sphinx-quickstart. The following is how
>
> The docstring for doctest.DocTestRunner contains the example code
>
> I was looking for.
>
>
Thanks, I will give it a try!
>
> --
>
> Neil Cerutti
--
https://mail.python.org/mailman/listinfo/python-list
On 2013-09-23, Luca Cerone wrote:
>> It won't be very good documenation any more but nothing stops you
>>
>> from examining the result in the next doctest and making yourself
>>
>> happy about it.
>>
>>
>>
>> >>> x = input("indeterminate:")
>>
>> >>> result = "'{}'".format(x))
>>
>> >
On 2013-09-23, Neil Cerutti wrote:
> Perhaps try the "advanced API" and define your oen
> OutputChecker to add the feature that you need.
>
> Figuring out how to best invoke doctest with your modified
> OutputChecker will take some digging in the source, probably
> looking at doctest.testmod. I do
> I don't know why but it seems that google groups stripped the indentation
> from the code.
Because it's Google Groups. :-)
800-pound gorillas tend to do pretty much whatever they want.
Skip
--
https://mail.python.org/mailman/listinfo/python-list
I don't know why but it seems that google groups stripped the indentation from
the code. I just wanted to ensure you that in the examples that I have run
the definition of myfunc contained correctly indented code!
On Monday, 23 September 2013 15:45:43 UTC+1, Luca Cerone wrote:
> .. doctest:: exa
> It won't be very good documenation any more but nothing stops you
>
> from examining the result in the next doctest and making yourself
>
> happy about it.
>
>
>
> >>> x = input("indeterminate:")
>
> >>> result = "'{}'".format(x))
>
> >>> result.startswith("'") and result.endswith("'
On 2013-09-22, Luca Cerone wrote:
> I understand your point, but now I am not writing unit tests to
> check the correctness of the code. I am only writing a tutorial
> and assuming that the code is correct. What I have to be sure
> is that the code in the tutorial can be executed correctly, and
>
On Sun, 22 Sep 2013 09:39:07 -0400, Ned Batchelder wrote:
> On 9/22/13 12:09 AM, Luca Cerone wrote:
>> Hi Chris,
>> actually my priority is to check that the code is correct. I changed
>> the syntax during the development, and I want to be sure that my
>> tutorial is up to date.
>>
>>
> If you do
st but the only assertion you're
>
> allowed to make is self.assertEqual(str(X), "")
>
>
I don't know unittest, is it possible to use it within Sphinx?
>
> --Ned.
--
https://mail.python.org/mailman/listinfo/python-list
> This makes no sense. If you ignore the output, the code could do ANYTHING
>
> and the test would still pass. Raise an exception? Pass. SyntaxError?
>
> Pass. Print "99 bottles of beer"? Pass.
>
if you try the commands, you can see that the tests fail..
for example
.. doctest::
>>> rais
On 9/22/13 12:09 AM, Luca Cerone wrote:
Hi Chris,
actually my priority is to check that the code is correct. I changed the syntax
during the development, and I want to be sure that my tutorial is up to date.
If you do manage to ignore the output, how will you know that the syntax
is correct?
On Sat, 21 Sep 2013 21:15:48 -0700, Luca Cerone wrote:
> I am looking for a way to test the code while ignoring the output.
This makes no sense. If you ignore the output, the code could do ANYTHING
and the test would still pass. Raise an exception? Pass. SyntaxError?
Pass. Print "99 bottles of
doctests for the documentation..
>
> How can I do what you call smoke tests in my Sphinx documentation?
I don't know Sphinx, so I can't help there. But maybe you should just
have a pile of .py files, and you import each one and see if you get
an exception?
ChrisA
--
https://mail.python.org/mailman/listinfo/python-list
>
> That is not how doctest works. That test fails because its output is:
ok.. is there a tool by which I can test if my code runs regardless the output?
>
> The only wild-card output that doctest recognises is ellipsis, and like
>
> all wild-cards, can match too much if you aren't careful. I
ring the development, and I want to be sure that my tutorial is up to date.
The user will only see the examples that, after testing with doctest, will
run. They won't know that I used doctests for the documentation..
How can I do what you call smoke tests in my Sphinx documentation?
--
On Sat, 21 Sep 2013 09:25:26 -0700, Luca Cerone wrote:
>> And if you ignore the output, the error won't be caught either. What's
>> the difference?
>>
>> >>> 1 + 1 #doctest:+IGNORE_OUTPUT (not a real directive)
>> 1000
>>
>>
> The difference is that in that case you want to check whether the
On Sun, Sep 22, 2013 at 2:25 AM, Luca Cerone wrote:
> The difference is that in that case you want to check whether the result is
> correct or not, because you expect a certain result.
>
> In my case, I don't know what the output is, nor care for the purpose of the
> tutorial. What I care is bei
t;
>
> So you simply can't do what you want. You can't both ignore the output of
>
> a doctest and have doctest report if the test fails.
>
OK, maybe it is not possible using doctest. Is there any other way to do what I
want? For example using an other Sphinx extension??
--
https://mail.python.org/mailman/listinfo/python-list
On Sat, 21 Sep 2013 05:44:09 -0700, Luca Cerone wrote:
> If you use a SKIP
> directive on code that contains a typo, or maybe you changed the name of
> a keyword to make it more meaningful and forgot to update your
> docstring, then the error won't be caught.
And if you ignore the output, the err
Dear Steven,
thanks for the help.
I am aware that I might have used the SKIP directive (as I hinted in my mail).
Even if the fine manual suggests to do so I don't agree with it, though.
The reason is simple: SKIP as the name suggests causes the code not to be run
at all, it doesn't ignore the out
On Sat, 21 Sep 2013 03:47:26 -0700, Luca Cerone wrote:
> Dear all,
> I am writing the documentation for a Python package using Sphinx.
>
> I have a problem when using doctest blocks in the documentation: I
> couldn't manage to get doctest to run a command but completely i
Dear all,
I am writing the documentation for a Python package using Sphinx.
I have a problem when using doctest blocks in the documentation:
I couldn't manage to get doctest to run a command but completely ignoring
the output.
For example, how can I get a doctest like the following t
- Original Message -
> What controls the yellow highlight bar that Sphinx sometimes puts in
> the
> documentation?
> E.g.:
> .. py:function:: basic_parseStrTest ()
> generates bold-face text, where
> .. py:function:: basicParseStrTest ()
> generates text with a yell
What controls the yellow highlight bar that Sphinx sometimes puts in the
documentation?
E.g.:
.. py:function:: basic_parseStrTest ()
generates bold-face text, where
.. py:function:: basicParseStrTest ()
generates text with a yellow bar highlight.
I actually rather like the yellow bar highlight
So now it works, but taking my project get some trouble. I use in MyData my
ConfigParser Class for configuration issues. The project.ini file is in
/project and has some entries.
[Logging]
my_data:MyData.py#/tmp/MyData.log#logging.WARN
I guess Sphinx has trouble to load the ini-file!?
Thanks
Got it spelling error!
--
http://mail.python.org/mailman/listinfo/python-list
On 10/27/2012 06:18 AM, mining.fa...@googlemail.com wrote:
> Hi,
>
> I figure out how it works with sphinx documentation. But I'm stucked
> in the sys.path issue?
>
> sys.path.insert(0, '/home/chris/projekte/dev/testmodule')
>
> /home/chris/projekte/dev/te
Hi,
I figure out how it works with sphinx documentation. But I'm stucked
in the sys.path issue?
sys.path.insert(0, '/home/chris/projekte/dev/testmodule')
/home/chris/projekte/dev/testmodule/doc/source/code.rst:4: WARNING: autodoc
can't import/find module 'myproject
On 12/08/2011 02:09 PM, sajuptpm wrote:
Hi,
I am trying source code documentation using Sphinx. Here i have to
copy paste all modules in to *.rst file, that is painful. Have any way
to create documentation (doc for all modules, classes and methods in
the project directory) from project folder
Hi,
I am trying source code documentation using Sphinx. Here i have to
copy paste all modules in to *.rst file, that is painful. Have any way
to create documentation (doc for all modules, classes and methods in
the project directory) from project folder quickly. I also plannig to
add a code
Anybody knows?
Have a nice weekend!
Michael
--
http://mail.python.org/mailman/listinfo/python-list
.
* Multi level project management.
* Full text search.
* Generate web pages by Python Sphinx tools,
http://sphinx.pocoo.org . Lots of quick menus help you write and
preview
Python Sphinx and reStructuredText markup documents.
* Multi platform support, Windows, Linux, Mac, etc.
Home page
Hi guys!
I'm trying to create method to perform query at sphinx index, can anyone
does something like this before?
I appreciate !
Ageu
--
*" A Vida é arte do Saber...Quem quiser saber tem que Estudar!"*
http://bucolick.tumblr.com
http://artecultural.wordpress.com/
--
http://
Laszlo Nagy wrote:
In my shopzeus.db.pivot.convert.py file, in the run() method of my
Data2Facts class, I can write this into the docstring:
...you may have more joy asking about this on the Sphinx list:
http://groups.google.com/group/sphinx-dev
cheers,
Chris
--
http://mail.python.org
time.
I want to make this my current module for cross-referencing. So I tried
this:
.. :currentmodule:: shopzeus.db.pivot.convert
The :meth:`Data2Facts.prepare` method is used for blablabla
But it does not work! It is displayed in bold, but there is no link. The
sphinx build comman
I am trying to install Sphinx-1.0b under a Python3 environment.
Does anyone have experience with that task?
cd *1.0b2
python3 setup.py build
File "setup.py", line 50
print 'ERROR: Sphinx requires at least Python 2.4 to run.'
So
../
2to3 -w Sphinx-1.0b2
...
Refac
> epydoc supports reStructured text markups.
Oh, good. For a moment there, I thought I'd be stuck with a markup
language that was persnickety!
--
http://mail.python.org/mailman/listinfo/python-list
Phlip wrote:
On May 11, 3:54 am, Jean-Michel Pichavant
wrote:
I remember trying using Sphinx for auto documented APIs, but it was not
suitable at that time. You can include API docs generated from the code,
but you still need to write the docs around.
If I'm correct, Sphinx is one o
On May 11, 3:54 am, Jean-Michel Pichavant
wrote:
> I remember trying using Sphinx for auto documented APIs, but it was not
> suitable at that time. You can include API docs generated from the code,
> but you still need to write the docs around.
> If I'm correct, Sphinx is one
Phlip wrote:
On May 10, 1:51 pm, Phlip wrote:
On May 10, 1:39 pm, Chris Rebert wrote:
Sphinx is in vogue right now:http://sphinx.pocoo.org/
Okay, we have ten thousand classes to document. How to add them all to
index.rst?
I remember trying using Sphinx for auto
On May 10, 1:51 pm, Phlip wrote:
> On May 10, 1:39 pm, Chris Rebert wrote:
>
> > Sphinx is in vogue right now:http://sphinx.pocoo.org/
Okay, we have ten thousand classes to document. How to add them all to
index.rst?
--
http://mail.python.org/mailman/listinfo/python-list
On May 5, 8:00 am, James Mills wrote:
> On Wed, May 5, 2010 at 3:35 PM, Michele Simionato
>
> wrote:
> > I am sure it has, but I was talking about just putting in the
> > repository an index.html file and have it published, the wayI hear it
> > works in BitBucket and GitHub.
>
> I'm pretty sure
port
rendering text/html mime-type files in the repository (like Trac can).
On a side-note, not sure if you're interested in this at all...
I wrote (for the hell/fun of it) a "Sphinx Server", here's the code:
http://codepad.org/ywo8pscb
This uses the latest development version
On May 5, 6:39 am, James Mills wrote:
> On Wed, May 5, 2010 at 2:08 PM, Michele Simionato
>
> wrote:
> > Interesting. I tried to see if the same was true for the Wiki in
> > Google code but apparently it does not work. Does anybody here know if
> > it is possible to publish raw html in the Google
On Wed, May 5, 2010 at 2:08 PM, Michele Simionato
wrote:
> Interesting. I tried to see if the same was true for the Wiki in
> Google code but apparently it does not work. Does anybody here know if
> it is possible to publish raw html in the Google Code wiki and how
> does it work?
I may be wrong,
On May 4, 9:48 am, James Mills wrote:
> On Tue, May 4, 2010 at 5:27 PM, Michele Simionato
>
> wrote:
> > Cool, that's good to know. I am still accepting recommendations for
> > non-Python projects ;)
>
> bitbucket (1) also provide static file hosting through the wiki. From
> what I understand (te
On Tue, May 4, 2010 at 5:27 PM, Michele Simionato
wrote:
> Cool, that's good to know. I am still accepting recommendations for
> non-Python projects ;)
bitbucket (1) also provide static file hosting through the wiki. From
what I understand (tested)
you simply clone the wiki repository (which is i
On May 4, 8:37 am, "Martin v. Loewis" wrote:
> > Do you know of recent improvements on the PyPI side about docs
> > hosting?
>
> Yes; go to your package's pkg_edit page, i.e.
>
> http://pypi.python.org/pypi?%3Aaction=pkg_edit&name=decorator
>
> and provide a zip file at Upload Documentation.
>
> R
> Do you know of recent improvements on the PyPI side about docs
> hosting?
Yes; go to your package's pkg_edit page, i.e.
http://pypi.python.org/pypi?%3Aaction=pkg_edit&name=decorator
and provide a zip file at Upload Documentation.
Regards,
Martin
--
http://mail.python.org/mailman/listinfo/pyt
On May 4, 8:07 am, "Martin v. Loewis" wrote:
> If it's a Python package that this documentation is about, you can host
> it on PyPI.
It must not be Python, but let's consider this case first. How does it
work? When I published
my decorator module (http://pypi.python.org/pypi/decorator) the
suppor
Michele Simionato wrote:
> Say you have a project with a lot of documentation in the form of
> Sphinx pages (for instance a book project). What is the the easiest
> way to publish it on the Web? I see that GitHub Pages allows you to
> publish static pages, but I would need to check
Say you have a project with a lot of documentation in the form of
Sphinx pages (for instance a book project). What is the the easiest
way to publish it on the Web? I see that GitHub Pages allows you to
publish static pages, but I would need to check in both the .rst
sources and the .html output
er not hand generate the main reST
> > structure. I am hoping to use Sphinx like Epydoc and just run it on a
> > code base and have it generate the API documentation.
>
> Sphinx will probably never grow the ability to do that for you. Using epydoc
> as
> a library to collect docst
On 2009-03-05 19:23, Paul Hildebrandt wrote:
Thanks, I've been playing with that but I believe it assumes a reST
structure you build, then use autodoc to bring in your code's
docstrings. I would rather not hand generate the main reST
structure. I am hoping to use Sphinx like Epydo
On Mar 5, 1:22 pm, Benjamin Peterson wrote:
> 2009/3/5 andrew cooke :
>
> > Benjamin Peterson wrote:
> >> Paul Hildebrandt yahoo.com> writes:
> >>> I really like the look of Sphinx BUT I want autogenerated
> >>> documentation like Epydoc/doxygen.
1 - 100 of 109 matches
Mail list logo
