Re: Documentation is now read-only

2020-05-11 Thread Martin Michlmayr
* Kirill Goncharov [2020-05-11 12:37]: > Update: All major issues were resolved! > > Full API reference now available at > https://xuhcc.github.io/beancount-docs/api_reference/index.html Impressive speed! Thanks to you and your responsive upstream! -- Martin Michlmayr https://www.cyrius.com/

Re: Documentation is now read-only

2020-05-11 Thread Kirill Goncharov
Update: All major issues were resolved! Full API reference now available at https://xuhcc.github.io/beancount-docs/api_reference/index.html On Monday, May 11, 2020 at 2:52:29 PM UTC+3, Kirill Goncharov wrote: > > MkDocs has several plugins that could build documentation from docstrings. > > I tr

Re: Documentation is now read-only

2020-05-11 Thread Martin Blais
Martin: Yes, Kirill's docs are awesome. You've got some newfound Kix power on the Beancount docs; use them wisely. On Mon, May 11, 2020 at 3:14 AM Martin Michlmayr wrote: > * Kirill Goncharov [2019-08-02 02:18]: > > Docs now available at GitHub Pages: > https://xuhcc.github.io/beancount-docs/

Re: Documentation is now read-only

2020-05-11 Thread Kirill Goncharov
MkDocs has several plugins that could build documentation from docstrings. I tried mkdocstrings (https://github.com/pawamoy/mkdocstrings). It doesn't support readthedocs theme and its parser has issues, so I was not able to add documentation for all modules: https://xuhcc.github.io/beancount-do

Re: Documentation is now read-only

2020-05-11 Thread Martin Michlmayr
* Kirill Goncharov [2019-08-02 02:18]: > Docs now available at GitHub Pages: https://xuhcc.github.io/beancount-docs/ I found a number of formatting issues but they are problems in the Google docs (I left some comments). This looks really good. Thanks for working on this! -- Martin Michlmayr ht

Re: Documentation is now read-only

2020-05-10 Thread Martin Michlmayr
* Kirill Goncharov [2019-08-02 02:18]: > Docs now available at GitHub Pages: https://xuhcc.github.io/beancount-docs/ This is very impressive. But afaict it doesn't have the API reference that Dominik's version has. His uses Sphinx whereas you use MkDocs. Is there any chance we could agree one

Re: Documentation is now read-only

2019-08-07 Thread Kirill Goncharov
Yes, that would be awesome! We can then similarly configure https://github.com/beancount/beancount repo to serve markdown documents using the Github Pages service. среда, 7 августа 2019 г., 4:32:15 UTC+3 пользователь Martin Blais написал: > > Very nice conversion. > Nice work on fixing the code

Re: Documentation is now read-only

2019-08-06 Thread Martin Blais
Very nice conversion. Nice work on fixing the code block formatting by converting the source... If you would like I could trigger conversions on major/minor releases and check in the markdown next to the source code. On Mon, Aug 5, 2019 at 2:38 PM Kirill Goncharov wrote: > >I think a theme s

Re: Documentation is now read-only

2019-08-05 Thread Kirill Goncharov
>I think a theme similar to the Read The Docs one makes reading long sectioned documents a bit easier. Have you considered something like it? I don't know if such a theme exists. By default, GitHub supports these themes: https://pages.github.com/themes/, but they all are different from Read th

Re: Documentation is now read-only

2019-08-05 Thread Daniele Nicolodi
On 03-08-2019 04:42, Stefano Zacchiroli wrote: > On Fri, Aug 02, 2019 at 02:18:20AM -0700, Kirill Goncharov wrote: >> Docs now available at GitHub Pages: https://xuhcc.github.io/beancount-docs/ > > Thanks a lot for doing this, it's awesome ! Indeed, I like it much better than the Google Docs vers

Re: Documentation is now read-only

2019-08-03 Thread Stefano Zacchiroli
On Fri, Aug 02, 2019 at 02:18:20AM -0700, Kirill Goncharov wrote: > Docs now available at GitHub Pages: https://xuhcc.github.io/beancount-docs/ Thanks a lot for doing this, it's awesome ! -- Stefano Zacchiroli . z...@upsilon.cc . upsilon.cc/zack . . o . . . o . o Computer Science Professor . CTO

Re: Documentation is now read-only

2019-08-03 Thread Kirill Goncharov
I'll update it regularly, maybe once in a week. Source files in markdown format are generated automatically from Google documents by a script. суббота, 3 августа 2019 г., 10:21:49 UTC+3 пользователь Red S написал: > > This is terrific. It loads so much faster than google docs, doesn't need > an

Re: Documentation is now read-only

2019-08-03 Thread Red S
This is terrific. It loads so much faster than google docs, doesn't need an app/sign in. Thank you for doing this. May I know what you had in mind for the update policy? How up-to-date with the originals will this be? Thanks again! On Friday, August 2, 2019 at 2:18:20 AM UTC-7, Kirill Goncharo

Re: Documentation is now read-only

2019-08-02 Thread Kirill Goncharov
Docs now available at GitHub Pages: https://xuhcc.github.io/beancount-docs/ среда, 26 июня 2019 г., 16:07:52 UTC+3 пользователь Kirill Goncharov написал: > > I wrote another script for parsing Google Docs. If anyone interested, the > result is at > https://github.com/xuhcc/beancount-docs/blob/m

Re: Documentation is now read-only

2019-06-26 Thread Uwe Ziegenhagen
That looks pretty good. I used Pandoc to convert the MD files to PDF via xelatex, find the result here: http://uweziegenhagen.de/converted.pdf Not perfect, but for a quick & dirty approach it is fine. Are there any plans to switch to the github markdown for the documentation instead of using Goo

Re: Documentation is now read-only

2019-06-26 Thread Kirill Goncharov
I wrote another script for parsing Google Docs. If anyone interested, the result is at https://github.com/xuhcc/beancount-docs/blob/master/docs/00_beancount_documentation.md -- You received this message because you are subscribed to the Google Groups "Beancount" group. To unsubscribe from this

Re: Documentation is now read-only

2019-02-17 Thread Martin Blais
I really think this could work. I've downloaded the JSONs for all the current Beancount docs here: https://bitbucket.org/blais/beancount-jsondocs/src/default/ There's a little Python script in there you can just run, I hacked on this for a half hour, just kicking the tires. If anyone would like to

Re: Documentation is now read-only

2019-02-17 Thread Martin Blais
I just tried it, this API provides enough detail to do a much better job at converting to Markdown. I could easily and reliably identify code blocks with it. On Sun, Feb 17, 2019 at 3:51 PM Martin Blais wrote: > That looks nice and promising indeed, you get access to their structure of > the do

Re: Documentation is now read-only

2019-02-17 Thread Martin Blais
That looks nice and promising indeed, you get access to their structure of the document: https://developers.google.com/docs/api/concepts/structure Thanks for sending a pointer to this. I hadn't noticed this release. I haven't done any work with this yet. It looks like it could potentially work.

Re: Documentation is now read-only

2019-02-15 Thread llpamies
Google recently released the API for Docs [1]. This should make the export process easier. Has anyone looked at it? Is anyone working on this? [1] https://developers.google.com/docs/api/reference/rest/v1/documents#Document On Wednesday, November 28, 2018 at 8:00:24 PM UTC-8, Martin Blais wrote:

Re: Documentation is now read-only

2018-11-28 Thread Martin Blais
On Tue, Nov 27, 2018 at 10:24 PM Oon-Ee Ng wrote: > On Thu, May 10, 2018 at 11:29 AM Martin Blais wrote: > >> On Wed, May 9, 2018 at 8:29 AM, Martin Michlmayr wrote: >> >>> * Martin Blais [2018-03-24 00:35]: >>> > BTW, here's what the current automated conversion results looks like in >>> > yo

Re: Documentation is now read-only

2018-11-27 Thread Oon-Ee Ng
On Thu, May 10, 2018 at 11:29 AM Martin Blais wrote: > On Wed, May 9, 2018 at 8:29 AM, Martin Michlmayr wrote: > >> * Martin Blais [2018-03-24 00:35]: >> > BTW, here's what the current automated conversion results looks like in >> > your static skeleton: >> > http://furius.ca/tmp/beancount-docs

Re: Documentation is now read-only

2018-05-09 Thread Martin Blais
On Wed, May 9, 2018 at 8:29 AM, Martin Michlmayr wrote: > * Martin Blais [2018-03-24 00:35]: > > BTW, here's what the current automated conversion results looks like in > > your static skeleton: > > http://furius.ca/tmp/beancount-docs/ > > http://furius.ca/tmp/beancount-docs/users/installation.h

Re: Documentation is now read-only

2018-05-09 Thread Martin Michlmayr
* Martin Blais [2018-03-24 00:35]: > BTW, here's what the current automated conversion results looks like in > your static skeleton: > http://furius.ca/tmp/beancount-docs/ http://furius.ca/tmp/beancount-docs/users/installation.html has some formatting issues. It seems ReST links are created for

Re: Documentation is now read-only

2018-03-25 Thread Martin Blais
On Sat, Mar 24, 2018 at 6:15 AM, Dominik Aumayr wrote: > This looks great! Thanks for working on this! :) > > > It's incomplete, but you can see how pretty darn close it is (it's > readable, but flawed). > > Except for the code blocks (they should be in a monospaced font, as > otherwise it would

Re: Documentation is now read-only

2018-03-25 Thread Martin Blais
On Sat, Mar 24, 2018 at 12:33 PM, Stefano Zacchiroli wrote: > On Sat, Mar 24, 2018 at 12:35:23AM -0400, Martin Blais wrote: > > BTW, here's what the current automated conversion results looks like in > > your static skeleton: > > http://furius.ca/tmp/beancount-docs/ > > This is just ... wow ... a

Re: Documentation is now read-only

2018-03-24 Thread Stefano Zacchiroli
On Sat, Mar 24, 2018 at 12:35:23AM -0400, Martin Blais wrote: > BTW, here's what the current automated conversion results looks like in > your static skeleton: > http://furius.ca/tmp/beancount-docs/ This is just ... wow ... amazing work Martin, thanks for doing this! My only comment (in the same

Re: Documentation is now read-only

2018-03-24 Thread Dominik Aumayr
This looks great! Thanks for working on this! :) > It's incomplete, but you can see how pretty darn close it is (it's readable, > but flawed). Except for the code blocks (they should be in a monospaced font, as otherwise it would be confusing for the reader), and the sidebar (can be configured

Re: Documentation is now read-only

2018-03-23 Thread Martin Blais
Thx Dominik. BTW, here's what the current automated conversion results looks like in your static skeleton: http://furius.ca/tmp/beancount-docs/ This was entirely produced by the code I wrote here, no manual changes: https://bitbucket.org/blais/beancount/src/tip/experiments/docs_rst/ It's incompl

Re: Documentation is now read-only

2018-03-16 Thread Dominik Aumayr
> - Eventually I'd like to merge that into Beancount itself and maintain it > (with Dominik's permission). Permission hereby granted :-) > Am 14.03.2018 um 06:08 schrieb Martin Blais : > > I just cleaned up the hacky conversion code a bit. > > If anybody would like to have a go at completing

Re: Documentation is now read-only

2018-03-13 Thread Martin Blais
I just cleaned up the hacky conversion code a bit. If anybody would like to have a go at completing this, the source is here: https://bitbucket.org/blais/beancount/src/tip/experiments/ docs_rst/?at=default Instead of running the download_docs.py script, which might require a Google API token, I m

Re: Documentation is now read-only

2018-03-11 Thread Martin Blais
Not planning to move to rst as an input format. I still would use GDocs as input; just request comment access and I'll accept liberally. The idea would be to fully automate the conversion. (The only reason I made the docs RO was to avoid the numerous and frequent fingerfarts.) On Sat, Mar 10, 2018

Re: Documentation is now read-only

2018-03-10 Thread Martin Michlmayr
* Martin Blais [2018-02-20 00:07]: > Anyhow, I'll try to finish this and convert all the docs to rst at some > point. Once the rst documents exist, are you going to accept pull requests with changes against the rst (and apply them to your canonical source) or how should people interested in worki

Re: Documentation is now read-only

2018-02-19 Thread Martin Blais
BTW, I just made some manner of progress toward this. I went about this in a bit of a roundabout way, I wrote a script that extracts the indented code blocks from the Docs to docx conversion, and inserts them into the docx to rst conversion output (done with Pandoc, which strips the indentation on

Re: Documentation is now read-only

2017-11-05 Thread Martin Blais
On Mon, Oct 30, 2017 at 9:38 AM, Stefano Zacchiroli wrote: > Heya, > > On Sun, Sep 24, 2017 at 03:33:03AM -0400, Martin Blais wrote: > > here's a snapshot of all the documents exported to all the available > > formats: http://furius.ca/tmp/beancount/beancount-docs-exported.tar.gz > > Thanks for t

Re: Documentation is now read-only

2017-10-30 Thread Stefano Zacchiroli
Heya, On Sun, Sep 24, 2017 at 03:33:03AM -0400, Martin Blais wrote: > here's a snapshot of all the documents exported to all the available > formats: http://furius.ca/tmp/beancount/beancount-docs-exported.tar.gz Thanks for this, very useful. I've started looking into automatically converting to

Re: Documentation is now read-only

2017-09-24 Thread Martin Blais
For those who would like to have a shot at automating the conversion of Beancount's Google Docs files to Markdown - a topic which fills the hearts of some with great passion - here's a snapshot of all the documents exported to all the available formats: http://furius.ca/tmp/beancount/beancount-docs

Re: Documentation is now read-only

2017-08-15 Thread Stefano Zacchiroli
On Mon, Aug 14, 2017 at 11:29:30PM -0400, Martin Blais wrote: > I could whine here about the advocacy on the mailing-list---as you > already know, I don't care much for it. I'm a pragmatist. > > But let me not do that and instead turn your bottomless energy into a > productive channel: This is not

Re: Documentation is now read-only

2017-08-14 Thread Martin Blais
On Mon, Aug 14, 2017 at 3:42 PM, Stefano Zacchiroli wrote: > On Mon, Aug 14, 2017 at 01:53:41AM -0400, Martin Blais wrote: > > > Is there an easy way to search beancount's documentation within > > > Google Docs? > > > > AFAIK you can search from the Drive interface. Just add the word > > "beancou

Re: Documentation is now read-only

2017-08-14 Thread Stefano Zacchiroli
On Mon, Aug 14, 2017 at 01:53:41AM -0400, Martin Blais wrote: > > Is there an easy way to search beancount's documentation within > > Google Docs? > > AFAIK you can search from the Drive interface. Just add the word > "beancount" and some terms. AFAICT this works only if you are logged into a Goo

Re: Documentation is now read-only

2017-08-13 Thread Zhuoyun Wei
2017-08-14 01:53:41 Martin Blais : > > > AFAIK you can search from the Drive interface. Just add the word "beancount" > and some terms. > It suddenly occurred to me that since the Docs is now read-only, could we utilize the /pub feature [1] of Docs? I am not sure if this helps Google and other

Re: Documentation is now read-only

2017-08-13 Thread Martin Blais
On Mon, Aug 14, 2017 at 1:26 AM, wrote: > I'm not hugely excited about Google products in general due to their > corrosively broad erosion of privacy in society (same thing goes for > Facebook's platform in my opinion). > No comment. > But given that you've found Google Docs efficient for pro

Re: Documentation is now read-only

2017-08-13 Thread jkepler
I'm not hugely excited about Google products in general due to their corrosively broad erosion of privacy in society (same thing goes for Facebook's platform in my opinion). But given that you've found Google Docs efficient for producing quality documentation, great. Having good documentation i

Re: Documentation is now read-only

2017-08-13 Thread Martin Blais
On Sun, Aug 13, 2017 at 12:15 PM, Zhuoyun Wei wrote: > Glad to hear Beancount moves on from Google Docs. > It's not. It would just be nice to have a conversion from Docs to something static, for people like you who don't like the Docs format. No offense. But I was very confused when I first m

Re: Documentation is now read-only

2017-08-13 Thread Zhuoyun Wei
Glad to hear Beancount moves on from Google Docs. No offense. But I was very confused when I first met Beancount. Google Docs is a very good collaborating platform but a poor choice for software documentation. I remember when I needed to look up for some syntax or usage I cannot search thru the do

Re: Documentation is now read-only

2017-08-08 Thread Martin Blais
Hi Dominik, Thanks for your offer. I could indeed surely use some help with document conversion. Let me tell you what I did so far, and you can decide then. My goal is automatically download and convert the documentation from Google Docs, in a repeatable way. (I don't really want to move away fro

Re: Documentation is now read-only

2017-08-06 Thread Dominik Aumayr
> I'd like to automate this conversion and publish a copy of Dominik Aumayr's > static docs with the gdocs embedded in them. If you need help with that, or if I should update/modify the static docs to better suit your needs and the transition, just let me know. Happy to help! - Dominik > Am 0

Re: Documentation is now read-only

2017-08-06 Thread Martin Blais
On Sun, Aug 6, 2017 at 3:40 PM, Stefano Zacchiroli wrote: > On Sun, Aug 06, 2017 at 01:52:31PM -0400, Martin Blais wrote: > > So for now I've made the docs read-only. > > If you need to comment, I think there might be a way to request comment > > access. > > Otherwise, try the mailing-list... > >

Re: Documentation is now read-only

2017-08-06 Thread Stefano Zacchiroli
On Sun, Aug 06, 2017 at 01:52:31PM -0400, Martin Blais wrote: > So for now I've made the docs read-only. > If you need to comment, I think there might be a way to request comment > access. > Otherwise, try the mailing-list... So, this makes me wonder: given the main argument for having documentati

Documentation is now read-only

2017-08-06 Thread Martin Blais
Hi, Much of the intentional comments on Beancount docs have been very useful and an effective way to communicate with users and answer various questions; they have helped improve the quality of the documentation tremendously. However, 90% of the comment emails I get are the result of "finger fart",