Commit graph

218 commits

Author SHA1 Message Date
Gina Häußge
4e69b260a1 Docs for user API
Also some fixes on said API and some fixes in the docs
2016-09-28 11:18:43 +02:00
Gina Häußge
82ae3f6f6e Re-added two utility methods removed in d9e3553c7c
They are still useful for other clients than the core application. Renamed them to fit the
general naming on the API however:

  * pathForElement is now called pathForEntry
  * elementByPath is now called entryForPath
2016-09-28 10:21:27 +02:00
Gina Häußge
0b551f6b7e Some more documentation 2016-09-22 22:21:52 +02:00
Gina Häußge
9845e3b4ea Restored accidentally removed file 2016-09-22 16:32:05 +02:00
Gina Häußge
8e8853c9c3 Lots of documentation updates + some related code fixes 2016-09-22 16:27:06 +02:00
Gina Häußge
b0a6a5675a Fixed two documentation bugs
Thanks @Salandora
2016-09-21 14:35:43 +02:00
Gina Häußge
6f029d6bf4 Docs and minor fixes for printer profile API 2016-09-21 12:05:17 +02:00
Gina Häußge
fc891ac651 Make sure volume.depth for circular beds is forced to width
Both width and depth should be the diameter. Adjusted docs
accordingly to reflect this too.
2016-09-21 10:45:40 +02:00
Gina Häußge
b8159cf16f Docs bug: Maximum feedrate for axes is mm/min 2016-09-20 13:46:47 +02:00
Gina Häußge
0833d9efce Fixed a link 2016-09-20 10:30:41 +02:00
Gina Häußge
0ac3881897 Use better name than "hook" for various plugin hook documentation 2016-09-20 10:29:53 +02:00
Gina Häußge
c7055440cc Migrated docs for all bundled plugins from wiki 2016-09-20 10:27:21 +02:00
Gina Häußge
7b4b638a2b Merge branch 'fix/pluginDocs' into dev/bundledPluginsDocs 2016-09-19 17:15:20 +02:00
Gina Häußge
b6fbbb353a Merge branch 'maintenance' into devel
# Conflicts:
#	CHANGELOG.md
#	src/octoprint/filemanager/storage.py
#	src/octoprint/plugins/softwareupdate/templates/softwareupdate_settings.jinja2
2016-09-09 12:31:29 +02:00
Gina Häußge
2b22d26eac Fixed a small issue with RFC 5987 headers arriving as unicode in parser
Also added API docs regarding header encoding, incl support for RFC 5987
for filename fields in Content-Disposition headers in multipart/form-data
parts, incl. an example of an upload request with a utf-8 encoded filename.
2016-09-07 18:44:46 +02:00
Gina Häußge
eb4be89d39 Renamed GcodeFileViewModel to FileViewModel
(Let's be realistic here)

Introduced new "additionalNames" property on viewmodel declaration
to allow for registering alternative lookup names for a view model.

The freshly renamed FileViewModel now resolves as both "filesViewModel"
 and "gcodeFilesViewModel", making the renaming backwards compatible

 Documented all that stuff (and some more)
2016-09-01 10:17:18 +02:00
Gina Häußge
a13e12bb5e More work on JS Client documentation 2016-08-26 17:47:38 +02:00
Gina Häußge
4ff869c2fa Docs for settings overlay & improved hook docs 2016-08-19 15:40:43 +02:00
Gina Häußge
aae01fe81b Merge branch 'maintenance' into devel
Conflicts:
	CHANGELOG.md
	docs/api/fileops.rst
	src/octoprint/plugins/virtual_printer/virtual.py
	src/octoprint/server/api/files.py
	src/octoprint/static/css/octoprint.css
	src/octoprint/static/js/app/dataupdater.js
	src/octoprint/static/js/app/main.js
	src/octoprint/static/js/app/viewmodels/files.js
	src/octoprint/static/js/app/viewmodels/settings.js
	src/octoprint/templates/sidebar/state.jinja2
	src/octoprint/util/comm.py
2016-07-28 15:00:23 +02:00
Gina Häußge
f9cb29ac91 A bunch of documentation fixes and updates 2016-07-28 09:43:41 +02:00
Gina Häußge
6cbf189104 Added some developer information 2016-07-18 12:00:04 +02:00
Gina Häußge
7908f5226f Merge pull request #1384 from docdawning/patch-2
Replaced broken link
2016-07-13 17:53:24 +02:00
Gina Häußge
0fec3aeca9 Merge branch 'patch-1' of https://github.com/cvignac/OctoPrint into maintenance 2016-07-12 11:52:27 +02:00
cvignac
12fcfda481 Typo correction in slicing.rst
In 'Retrieve all slicing profiles' :
'GET /api/slicing/profiles' -> 'GET /api/slicing'
2016-07-10 15:40:24 +03:00
Gina Häußge
5bf5e336ec Extend payload in various events
Added name and path various event print job events and
the upload event, deprecated the file property.

Had to move event triggering of the print job events to
the printer implementation, since the file manager
is not available in the comm layer. Added new callbacks
to the PrinterInterface to allow for that to be possible.
2016-07-08 12:54:58 +02:00
Gina Häußge
3a4902367b New event placeholders for path & origin 2016-07-08 12:52:40 +02:00
Gina Häußge
dfb8f51238 Extend payload in MetadataAnalysis events
Added name, path and origin, deprecated file property.
2016-07-08 10:50:13 +02:00
Gina Häußge
a2cd46899c Merge branch 'improve/intermediaryUrlsAndTimeouts' into devel
Conflicts:
	AUTHORS.md
	src/octoprint/plugins/virtual_printer/virtual.py
2016-07-06 13:32:03 +02:00
Mark Walker
5eefee3a4d RepRapFirmware style M23 select file
RepRapFirmware enumerates the gcode files starting at /gcode, it will
also interpret any relative path as being relative to that folder.
However a full absolute path will actually interpret as from the real
root of the SD card :-(

(cherry-picked from ac68570)
2016-07-06 05:17:44 +00:00
Mark Walker
3069e05766 Add RepRapPro style file opened to virtual printer
(cherry-picked from 257c4ed)
Conflicts:
	src/octoprint/plugins/virtual_printer/virtual.py
2016-07-06 05:14:10 +00:00
Gina Häußge
294203ffd5 Add absolute jog mode to printer API 2016-07-01 17:54:26 +02:00
Gina Häußge
52d272bd24 More work on the docs 2016-07-01 17:52:40 +02:00
Gina Häußge
72bc30eae5 Merge branch 'devel' into dev/jsclientdocs
Conflicts:
	src/octoprint/static/js/app/viewmodels/printerstate.js
2016-06-30 13:04:57 +02:00
Gina Häußge
2971c29f10 Merge branch 'improve/pauseApiCommand' into devel
Conflicts:
	src/octoprint/static/js/app/viewmodels/printerstate.js
2016-06-30 13:01:13 +02:00
Gina Häußge
73a85646c5 Added only pause/resume sub commands to job API
Implements #1393
2016-06-30 12:56:18 +02:00
Gina Häußge
cec2f7d917 WIP: More work on the documentation of the js client lib 2016-06-30 12:06:08 +02:00
Gina Häußge
b8405becb3 Fixed a typo 2016-06-29 09:41:53 +02:00
Gina Häußge
ca8bbe2de4 JS Client docs for OctoPrint.connection 2016-06-29 09:28:55 +02:00
Gina Häußge
5611f87339 Docs for JS client lib's base module 2016-06-28 19:22:31 +02:00
Gina Häußge
cd71efdc71 Merge branch 'devel' into dev/jsclientdocs 2016-06-28 18:28:55 +02:00
Gina Häußge
7207421051 Docs for new typePath property in file model 2016-06-28 13:02:23 +02:00
Gina Häußge
df5a6e42d7 Docs for additions to slicing event payload 2016-06-28 12:58:31 +02:00
Gina Häußge
b41c1d89f4 Docs for octoprint.printer.factory hook 2016-06-28 12:58:08 +02:00
James
87b85ce33a Replaced broken link
Replaced dead url: https://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins
with what I think is a suitable alternative: http://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins
2016-06-22 00:19:38 -06:00
Gina Häußge
6016b04d03 WIP: Started on JS Client docs 2016-06-15 09:47:32 +02:00
Gina Häußge
de78c14ae3 Merge branch 'maintenance' into devel
Conflicts:
	CHANGELOG.md
	src/octoprint/static/js/app/dataupdater.js
	src/octoprint/static/js/app/main.js
	src/octoprint/static/js/app/viewmodels/files.js
	src/octoprint/static/js/app/viewmodels/loginstate.js
2016-06-09 12:56:07 +02:00
Gina Häußge
5006b019af Add events for slicing profile manipulation
Events SlicingProfile(Added|Modified|Deleted). Initially thought to be necessary
to properly refresh available profiles in slicing dialog, not needed for that after
all but still left in and documented, might be useful for someone.
2016-06-06 18:12:32 +02:00
Doug Calobrisi
ebb93d9d2f Corrects example URL in Slicing API Doc
This fixes a simple typo in the API doc for fetching slicing profiles. The previous example had /profiles appended to it, whereas it should just be /api/slicing to fetch a list of all slicers and profiles.
2016-05-20 10:28:44 -04:00
Gina Häußge
ee185230a4 Refactored plugin docs + improved docs on sortables 2016-03-24 16:42:41 +01:00
Gina Häußge
6d95a5849b Add docs for hook ordering 2016-03-24 09:38:52 +01:00