[Numpy-discussion] documentation, sound and music [was: doc? music through mathematical relations between LPCM samples and musical elements/characteristics]

[Renato Fabbri]

I think you gave me the answers:

0) It seems reasonable to just use sphinx,
no jekyll or anything more, only if a need for it is found.
I might use some HTML generated by vimwiki for pure convenience.

1) Make the main documentation with sphinx.
That means joining:
<githubio sphinx music>
and
<readthedocs music>

2) github.io, gitbook, readthedocs, all is just as fine.
Maybe github.io makes it easier and has more features,
while readthedocs is maybe more traditional for these kinds
of python-related docs.

3) just realese on pypi, make the documentation fine
and tell the list. If any major release deserves a message,
it is ok to send.

3.1) A scikit to make psychoacoutic experiments, synthesize audio and music,
is not absurd nor deeply compelling.

4) Am I loosing something? Being mindful of this question is always good,
but that is it,
we are on track.
(the python and latex files are on github, so there is an issue tracker,
a wiki etc etc there if anything comes up)

tx++



On Wed, Jan 31, 2018 at 9:20 PM, Robert Kern <robert.kern at gmail.com> wrote:

> On Thu, Feb 1, 2018 at 7:38 AM, Renato Fabbri <renato.fabbri at gmail.com>
> wrote:
> >
> > Dear Scipy-ers,
> >
> > If you think I should split the message so that
> > things get more clear...
> >
> > But the things are:
> > 1) How to document numpy-heavy projects?
>
> There is nothing particularly special about numpy-heavy projects with
> respect to documentation. The tools used for numpy and scipy's
> documentation may (or may not) be useful to you. For example, you may want
> to embed matplotlib plots into your documentation.
>
>   https://pypi.python.org/pypi/numpydoc
>
> But if not, don't worry about it. Sphinx is all most numpy-heavy projects
> need, like most Python projects. Hosting the documentation on either
> readthedocs or Github is fine. Do whatever's convenient for you. Either is
> just as convenient for us.
>
> > 2) How to better make these contributions available
> > to the numpy/scipy community?
>
> Having it up on Github and PyPI is all you need to do. Participate in
> relevant mailing list conversations. While we don't forbid release
> announcement emails on either of the lists, I wouldn't do much more than
> announce the initial release and maybe a really major update (i.e. not for
> every bugfix release).
>
> > Directions will be greatly appreciated.
> > I suspect that this info is all gathered somewhere
> > I did not find.
>
> Sorry this isn't gathered anywhere, but truly, the answer is "there is not
> much to it". You're doing everything right. :-)
>
> --
> Robert Kern
>
> _______________________________________________
> NumPy-Discussion mailing list
> NumPy-Discussion at python.org
> https://mail.python.org/mailman/listinfo/numpy-discussion
>
>


-- 
Renato Fabbri
GNU/Linux User #479299
labmacambira.sourceforge.net
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20180131/97109bc0/attachment-0001.html>