search

andreikop / enki

A text editor for programmers
http://enki-editor.org
GNU General Public License v2.0
161 stars 38 forks source link

Unit test fixes for Windows and Sphinx documentation #146

Closed bjones1 closed 10 years ago

bjones1 commented 10 years ago
andreikop commented 10 years ago

Other failures might be caused by missing dependencies (markdown, etc). Will test it tomorrow

bjones1 commented 10 years ago

Andrei,

Great! We're making good progress on a reasonably solid Windows binary.

A thought on the docs: what do you think about keeping enki-editor.org the central source of documentation for Enki, but folding a few other things into the Sphinx documentation? Specifically, I propose moving the following into Sphinx, then publishing the Sphinx output on the web:

  1. The plugin tutorial at https://github.com/hlamer/enki/wiki/Plugins-tutorial
  2. The user manual at https://github.com/hlamer/enki/wiki/User-manual and its subpages (scheme, templates)
  3. The README.md file.

Also, are you able to build the Sphinx / CodeChat output? I want to make sure you can see the results...

Bryan

On Thu, Dec 5, 2013 at 10:58 AM, Andrei Kopats notifications@github.comwrote:

  • Merged 2 of 3 patches. unittests discovery freezes, like with Qutepart
  • Fixed search-replace test

Other failures might be caused by missing dependencies (markdown, etc). Will test it tomorrow

— Reply to this email directly or view it on GitHubhttps://github.com/hlamer/enki/pull/146#issuecomment-29915381 .

Bryan A. Jones, Ph.D. Associate Professor Department of Electrical and Computer Engineering 231 Simrall / PO Box 9571 Mississippi State University Mississippi state, MS 39762 http://www.ece.msstate.edu/~bjones bjones AT ece DOT msstate DOT edu voice 662-325-3149 fax 662-325-2298

Our Master, Jesus Christ, is on his way. He'll show up right on time, his arrival guaranteed by the Blessed and Undisputed Ruler, High King, High God.

andreikop commented 10 years ago

I've merged Forgot to delete

I had little time for Enki today near PC with Windows. After python-docutils and python-markdown installation only 2 tests failed:

Navigator tests will also pass probably, if ctags is available in PATH

bjones1 commented 10 years ago

Andrei,

Thanks for working on it. I now only have the Navigator failure with no extra fixes on my end. ctags is in my path:

C:\Users\bjones\Documents\enki_all\enki\tests>ctags ctags: No files specified. Try "ctags --help".

I'm working now on the preview to text sync feature. It's coming along fairly well. I can push if you'd like to see, but it's still in development.

Bryan

On Fri, Dec 6, 2013 at 11:46 AM, Andrei Kopats notifications@github.comwrote:

I've merged Forgot to delete

I had little time for Enki today near PC with Windows. After python-docutils and python-markdown installation only 2 tests failed:

  • Crash in opened_files_dock
  • Navigator

Navigator tests will also pass probably, if ctags is available in PATH

— Reply to this email directly or view it on GitHubhttps://github.com/hlamer/enki/pull/146#issuecomment-30013879 .

Bryan A. Jones, Ph.D. Associate Professor Department of Electrical and Computer Engineering 231 Simrall / PO Box 9571 Mississippi State University Mississippi state, MS 39762 http://www.ece.msstate.edu/~bjones bjones AT ece DOT msstate DOT edu voice 662-325-3149 fax 662-325-2298

Our Master, Jesus Christ, is on his way. He'll show up right on time, his arrival guaranteed by the Blessed and Undisputed Ruler, High King, High God.

andreikop commented 10 years ago

Bryan, I discovered that Enki docs where not buildable on http://enki.readthedocs.org/, so I restored old conf.py and use doc/index.rst as the entry point.

I also removed contents.rst, which includes doc/index.rst and some other files. I'd like to divide Enki documentation on 3 leves:

bjones1 commented 10 years ago

Andrei,

Yes, I'd expect a readthedocs failure, just didn't think about it. The 3-way split you propose makes sense. Given that there are only two literate programming sources, it doesn't make sense to run Sphinx on everything. My thoughts on moving forward:

  1. Keep user docs as it. Eventually, post some videos or something to improve it. But writing docs just isn't much fun or a priority for me...
  2. Keep the old Sphinx docs as is, mostly. Things I think need improving: the hacking guide, style guide, etc. should be linked here; IMHO, these github wiki pages should be move to Sphinx. At a minimum, there out to be links to them from Sphinx.
  3. My next project, after finishing up the preview fixes, will be to get CodeChat running on a single file from withing Enki, so the two literate programming source files will render nicely. I can also edit the existing .rst files to remove Sphinx-only markup, so they're render nicely from Enki.

Your thoughts?

andreikop commented 10 years ago

Keep user docs as it. Eventually, post some videos or something to improve it. But writing docs just isn't much fun or a priority for me...

the hacking guide should be linked here

Done. http://enki.readthedocs.org/en/latest/

github wiki pages should be move to Sphinx

Sphinx is used for the API docs, because it allows to autogenerate docs from the sources. But I like wiki, because it is more open for editing. Sphinx requires git clone, edit with text editor, commit, push, open a pull request, wait for a long time while it is merged. Wiki is immediately editable.

I can also edit the existing .rst files to remove Sphinx-only markup

Which markup is Sphinx-only? Docs shall be rendered correctly on rtfd.org.

bjones1 commented 10 years ago

The link looks great. Thanks!

Re: Sphinx markup -- I'm thinking of win/build.rst, which uses .. toctree, so it won't render correctly in Enki. I can put manual links in instead.