summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* tests: switch to pytest as the default test runner. See #153Christoph Reiter2018-02-102-2/+13
| | | | | | | | | | | The TEST_NAMES env var gets translated to work with the pytest syntax (foo.py::class::method). Rename one class which triggers a pytest warning because it starts with "Test" but isn't one. Remove erroring out on Python warnings as pytest triggers some deprecation warnings by default.
* docs: add pypi step to maintainer release listChristoph Reiter2018-02-071-0/+2
|
* docs: getting started: default to Python 3 everywhereChristoph Reiter2018-02-071-6/+6
|
* docs: update building/testing with new setup.py featuresChristoph Reiter2018-02-071-20/+25
|
* autotools: use flake8 instead of pep8/pyflakesChristoph Reiter2018-01-201-1/+1
| | | | | | | | | | | flake8 uses pep8/pycodestyle/pyflakes internally, so there should not by any difference. The nice thing about it is that we can store the configuration in setup.cfg and linting comes down to just executing "flake8". It also allows to ignore warnings with inline comments, so that when avoiding a warning isn't possible it doesn't need to be disabled for the whole codebase.
* Update NEWSChristoph Reiter2018-01-191-0/+1
| | | | List the authors like before and link them to the gitlab user profile.
* setup.py: add a "test" command which is equal to "make check" with autotoolsChristoph Reiter2018-01-191-15/+13
| | | | | | | | | | | | | | Adds a "build_tests" command which builds all resources required for testing. It has some simple dependency awareness and only rebuilds if any of the direct sources have changed. Passing -f/--force will force a rebuild. Adds a new "test" command which builds the main extension module in the source directory, runs "build_tests" and finally runs all tests. Extends the "distcheck" command to run the tests after extracting the source distribution and run the distcheck command in the gitlab CI script. Only tested on Linux.
* docs: Add Anaconda to the list of software that is using PyGObjectChristoph Reiter2018-01-121-0/+1
| | | | https://fedoraproject.org/wiki/Anaconda
* docs: Add custom roles for linking to gitlab issues and merge requestsChristoph Reiter2018-01-121-0/+3
| | | | | | This allows one to use :issue:`42` or :mr:`42` in the documentation and the NEWS file and will result in links pointing to the specified issue/merge request.
* docs: Update for the git repo move from git.gnome.org to gitlab.gnome.orgChristoph Reiter2018-01-107-24/+47
| | | | | | | | | | | Changes all the links to point to the gitlab instance. Adds the gitlab setup to the sphinx theme configuration, so the theme can show "Edit on GitLab" links on each page. Create a new page pointing to the git report and bug tracker. Someone on IRC mentioned that this info is hard to find, so try to make it more proiminent.
* docs: Include NEWS entries for releases not made on the master branchChristoph Reiter2017-12-211-1/+2
| | | | | So that every release is visible in the online documentation. The list is sorted by release date.
* docs: convert NEWS file to reST and link bugsChristoph Reiter2017-12-205-10/+11
| | | | | | | | | | | | | | | | | Looks nicer in the online docs and makes it easier to look up bugs and link to specific releases. Rename the custom reST role for bugs from gnomebug to bzbug. With the upcoming move to gitlab that makes it more clear that those are referencing bugzilla. Adjust the "make release-news" target to output something similar to the new format to make converting to reST easier. Update the maintainer release todo list to state that the changelog should be copied from stable branches to master. It would be nice if the NEWS file in master, which gets exposed on readthedocs, would contain all the information available.
* Add sphinx based documentationChristoph Reiter2017-12-1144-0/+2906
| | | | | | | | | | | | | | | | | | | | | | | Takes the documentation developed at https://github.com/pygobject/pygobject-docs and puts into /docs See https://pygobject.readthedocs.io for how it looks Now that we move to gitlab we can use webhooks to trigger builds on readthedocs from gitlab directly and we should also have a nicer contribution UX. This also gets rid of most of README/HACKING/INSTALL and moves most of the information into the documentation. The README is kept short and only makes clear what pygobject is and points to the online docs as that should answer all questions. setup.py now sets the content of README.rst as long_descriptions, as that is the content shown on PyPI. This makes the page on PyPI look the same as on gitlab. https://bugzilla.gnome.org/show_bug.cgi?id=791448
* Remove legacy docsChristoph Reiter2017-03-2022-3934/+0
| | | | | | | | | | | | They aren't shipped, can't be build and describe the old pygobject 2 interface. There also was a doc-dist make target, but it was broken. If someone wants to look things up they are in git or still online for 2.28: https://developer.gnome.org/pygobject/stable/ https://bugzilla.gnome.org/show_bug.cgi?id=777719
* Move gobject static functions and constants to giSimon Feltman2012-11-051-25/+0
| | | | | | | | | | | Replace the following functions with gi and overrides: type_children, type_interfaces, signal_list_ids, signal_list_names, signal_lookup, signal_name, type_parent. Assign SIGNAL_* and PARAM_* from gi SignalFlags and ParamFlags respectively. Move module level assignments of a number of static functions to the GObject.py overrides file. https://bugzilla.gnome.org/show_bug.cgi?id=687487
* [API change] Remove static filename_from_utf8() bindingMartin Pitt2012-11-031-32/+0
| | | | | | | | | | Replace static GLib.filename_from_utf8() with GI. The old static binding always tried to convert the result to an Unicode object, which will fail if the result is not UTF-8 encoded (which is the whole point of this function really!), so return bytes now. Although the static binding was rather useless before, this is technically an API break.
* Drop static glib_version and pyglib_version constantsMartin Pitt2012-11-032-69/+0
| | | | Use the GLib version from GI instead, and the already existing gi.version_info.
* Drop removed markup-escape-text() from reference documentationMartin Pitt2012-10-281-36/+0
|
* Remove static get_current_time() bindingMartin Pitt2012-10-281-26/+0
| | | | | Use GLib.get_real_time() through GI instead. Deprecate the function, as GLib.get_real_time() should be called directly.
* Remove static child_add_watch() bindingMartin Pitt2012-10-281-61/+0
| | | | | | Use the GLib API through GI instead, and provide override to keep backwards compatible API. Also allow using the actual GLib API, and deprecate the old static API of calling without a priority as first argument.
* Remove static io_add_watch() bindingMartin Pitt2012-10-261-106/+0
| | | | | | | | Use the GLib API through GI instead, and provide override to keep backwards compatible API. Also allow using the actual GLib API, and deprecate all other variants: - calling with an fd as first argument instead of an IOChannel - calling without a priority as second argument
* Drop static SPAWN_* constantsMartin Pitt2012-10-243-148/+13
| | | | | | | | | Use the introspected constants instead, which are identical. Add backwards compatible aliases. These constants are covered by tests/test_subprocess.py. https://bugzilla.gnome.org/show_bug.cgi?id=686765
* Drop static IO_* constantsMartin Pitt2012-10-241-52/+0
| | | | | | | Use the introspected constants instead, which are identical. Add backwards compatible aliases. These constants are covered by tests/test_iochannel.py.
* Remove static idle_add/timeout_add bindingsMartin Pitt2012-10-241-165/+0
| | | | | | Use the GLib functions through GI instead. Add overrides to ensure that default arguments continue to work as before, and that callbacks are called without an userdata argument if it wasn't specified.
* Remove static MainLoop, MainContext, and some GSource bindingsMartin Pitt2012-10-246-472/+1
| | | | | | | | | | | | | | | | | | glib's MainLoop and MainContext are fully introspectable these days, so remove our static bindings. This reduces our code, as well enables GLib API which hasn't been available through the static bindings before. This also requires dropping our custom static types for GLib Source, Timeout, and Idle. The latter two work fine with introspection and just need tiny overrides for a backwards compatible API. g_source_new() is not introspectable, though, so we need to keep our static wrappers for that. Move them from gi/_glib/pygsource.c to gi/pygi-source.c, so that it can use the GI API. Note that gi/_glib/pygsource.[hc] is still required for the static PollFD type which is used by the static IOChannel binding. Once the latter goes away, PollFD can be dropped as well. https://bugzilla.gnome.org/show_bug.cgi?id=686443
* [API change] Do not bind gobject_get_data() and gobject_set_data()Steve Frécinaux2012-10-231-63/+0
| | | | | | | | | | | | They will basically cause a crash if misused, and you can always use a python member attribute instead. These methods were marked as deprecated for 3.4 and throwing a warning, so let's remove them for good now. https://bugzilla.gnome.org/show_bug.cgi?id=641944 Co-Authored-By: Martin Pitt <martinpitt@gnome.org>
* Drop unnecessary static _glib bindingsMartin Pitt2012-10-232-329/+0
| | | | | Drop static pyglib bindings which have straightforward and working GLib GI bindings. Add tests for all dropped functions to ensure they keep working.
* Drop git.mkDaniel Narvaez2012-07-241-2/+0
| | | | | | | | | The autogenerated gitignores was missing several files. So we was using a manual .gitignore at the root. But since it's enough to add a couple of entries to it to cover the whole tree, there is no much point in using git.mk at all. https://bugzilla.gnome.org/show_bug.cgi?id=678192
* docs/Makefile.am and m4/python.m4: Python3 portability fixesDieter Verfaillie2011-09-091-1/+1
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=658652
* Fix documentation installation directoryDieter Verfaillie2011-09-071-2/+3
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=657054
* Remove GIO documentationSimon van der Linden2011-02-1142-19020/+1
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=638899
* Remove .gitignore files and use git.mkIgnacio Casal Quinteiro2011-01-272-7/+2
| | | | | git.mk is a script maintained in pango. From time to time we must check if it was updated and update it here.
* Fix a few uses of TRUE and FALSE in the docsPaul Bolle2010-09-236-25/+26
|
* Docs: replace gio.IO_ERROR_* with gio.ERROR_*Paul Bolle2010-04-083-45/+45
| | | | Signed-off-by: Paul Bolle <pebolle@tiscali.nl>
* Move threads_init() function from 'gobject' to 'glib'Paul Pogonyshev2009-11-101-29/+7
| | | | | Retain in original place for backward compatibility, but remove it from the docs.
* Specify programming language in .devhelp fileFrédéric Péters2009-08-301-1/+1
| | | | | This add a new language attribute (hardcoded to python) in the .devhelp file that is produced when using ref-html-style.xsl.
* Fix the gio.unix namespace in docsGian Mario Tagliaretti2009-06-236-28/+42
|
* Add docs for gio functions (mostly for content types)Gian Mario Tagliaretti2009-06-223-0/+398
|
* Add docs for gio.Unix[In|Out]putStream classesGian Mario Tagliaretti2009-06-214-0/+410
|
* Document that many functions got moved gobject -> glibPaul Pogonyshev2009-06-211-0/+7
|
* Add docs for class gio.DataOutputStreamGian Mario Tagliaretti2009-06-203-0/+507
|
* Add dpcs for class gio.DataInputStreamGian Mario Tagliaretti2009-06-154-0/+868
|
* Make gio.Emblem constructor new-stylePaul Pogonyshev2009-06-151-2/+49
| | | | | Add optional 'origin' parameter. Expand gio.Emblem documentation and mark gio.emblem_new_with_origin as sort-of-deprecated.
* Add docs for gio.BufferedOutputStream classGian Mario Tagliaretti2009-06-133-47/+325
|
* Fix gio.BufferedInputStream docsGian Mario Tagliaretti2009-06-131-2/+32
| | | | Added the constructor reference and fixed a typo in properties header
* Add docs for gio.BufferedInputStreamGian Mario Tagliaretti2009-06-133-0/+434
|
* Add docs for gio.MemoryOutputStreamGian Mario Tagliaretti2009-06-093-0/+178
|
* Wrap gio.memory_input_stream_new_from_dataGian Mario Tagliaretti2009-06-093-1/+155
| | | | | Add the wrapper for gio.memory_input_stream_new_from_data including docs and a test.
* Fix the docs for gio.FilterOutputStreamGian Mario Tagliaretti2009-06-021-3/+3
|
* Add gio.FilterOutputStream docsGian Mario Tagliaretti2009-06-023-0/+155
|