diff --git a/conf.py b/conf.py index 796aa537c..980524259 100644 --- a/conf.py +++ b/conf.py @@ -1,357 +1,359 @@ # -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/stable/config # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = 'Krita Manual' propername = 'Krita Manual' description = 'The official Krita Documentation' copyright = 'licensed under the GNU Free Documentation License 1.3+ unless stated otherwise' author = 'Krita Foundation' import os import subprocess # Get the git description if possible, to put it in the footer. try: gitcommitfriendly = subprocess.check_output(["git", "describe", "--always"]).decode("utf-8").strip() except subprocess.CalledProcessError as exc: gitcommitfriendly = None # We use the full githash for the epub identifier, if not, use the release number. try: gitcommithash = subprocess.check_output(['git', 'rev-parse', 'HEAD']).decode("utf-8").strip() except subprocess.CalledProcessError as exc: gitcommithash = release # The short X.Y version version = '4.1' # The full version, including alpha/beta/rc tags release = '4.1.7' # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path . exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] html_extra_path = ['.htaccess', '404.php'] # copy over .htaccess file to each langaguge # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A string of reStructuredText that will be included at the end of every source file that is read. # This is a possible place to add substitutions that should be available in every file (another being rst_prolog). rst_epilog = """ .. |mouseleft| image:: /images/icons/Krita_mouse_left.png .. |mouseright| image:: /images/icons/Krita_mouse_right.png .. |mousemiddle| image:: /images/icons/Krita_mouse_middle.png .. |mousescroll| image:: /images/icons/Krita_mouse_scroll.png .. |toolshapeselection| image:: /images/icons/shape_select_tool.svg .. |toolshapeedit| image:: /images/icons/shape_edit_tool.svg .. |tooltext| image:: /images/icons/text-tool.svg .. |toolcalligraphy| image:: /images/icons/calligraphy_tool.svg .. |toolgradientedit| image:: /images/icons/gradient_edit_tool.svg .. |toolpatternedit| image:: /images/icons/pattern_tool.svg .. |toolfreehandbrush| image:: /images/icons/freehand_brush_tool.svg .. |toolline| image:: /images/icons/line_tool.svg .. |toolrectangle| image:: /images/icons/rectangle_tool.svg .. |toolellipse| image:: /images/icons/ellipse_tool.svg .. |toolpolygon| image:: /images/icons/polygon_tool.svg .. |toolpolyline| image:: /images/icons/polyline_tool.svg .. |toolbeziercurve| image:: /images/icons/bezier_curve.svg .. |toolfreehandpath| image:: /images/icons/freehand_path_tool.svg .. |tooldyna| image:: /images/icons/dyna_tool.svg .. |toolmultibrush| image:: /images/icons/multibrush_tool.svg .. |toolassistant| image:: /images/icons/assistant_tool.svg .. |toolmove| image:: /images/icons/move_tool.svg .. |tooltransform| image:: /images/icons/transform_tool.svg .. |toolgrid| image:: /images/icons/grid_tool.svg .. |toolperspectivegrid| image:: /images/icons/perspectivegrid_tool.svg .. |toolmeasure| image:: /images/icons/measure_tool.svg .. |toolcolorpicker| image:: /images/icons/color_picker_tool.svg .. |toolfill| image:: /images/icons/fill_tool.svg .. |toolgradient| image:: /images/icons/gradient_drawing_tool.svg .. |toolcolorizemask| image:: /images/icons/colorizemask_tool.svg .. |toolsmartpatch| image:: /images/icons/smart_patch_tool.svg .. |toolcrop| image:: /images/icons/crop_tool.svg .. |toolselectrect| image:: /images/icons/rectangular_select_tool.svg .. |toolselectellipse| image:: /images/icons/elliptical_select_tool.svg .. |toolselectpolygon| image:: /images/icons/polygonal_select_tool.svg .. |toolselectpath| image:: /images/icons/path_select_tool.svg .. |toolselectoutline| image:: /images/icons/outline_select_tool.svg .. |toolselectcontiguous| image:: /images/icons/contiguous_select_tool.svg .. |toolselectsimilar| image:: /images/icons/similar_select_tool.svg .. |toolpan| image:: /images/icons/pan_tool.svg .. |toolzoom| image:: /images/icons/zoom_tool.svg +.. |toolreference| image:: /images/icons/reference_images_tool.svg + """ # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'theme' html_theme_path = ['.'] # make sphinx search for themes in current dir # the favicon has a property to set it in the documentation, but we don't need to use this # sphinx appears to automatically search in the theme folder and find the file #html_favicon = './theme/static/images/favicon.ico' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = { 'sticky_navigation': True, 'collapse_navigation': True, 'prev_next_buttons_location': 'bottom' } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['theme/static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} html_title = project + " version " + release html_context = { 'build_id': os.getenv('BUILD_NUMBER', None), 'build_url': os.getenv('BUILD_URL', None), 'commit' : gitcommitfriendly } # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = 'documentationProjectNamedoc' # -- Options for LaTeX output ------------------------------------------------ latex_engine = 'xelatex' latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', 'maxlistdepth': '8', 'figure_align':'ht!', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # 'preamble': r''' \usepackage[export]{adjustbox} \let\oincludegraphics\includegraphics \renewcommand{\includegraphics}[2][]{ \oincludegraphics[#1,max width=\linewidth,max height=\textheight]{#2} } ''', 'tableofcontents':'\sphinxtableofcontents', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'kritaManual.tex', project, author, 'manual'), ] latex_show_pagerefs=True # copy latex scripts to build dir latex_additional_files = [ "latexImageMakefile", ] # -- Internationalization Options -------------------------------------------- locale_dirs = ['locale/'] # Where the PO files will be stored at gettext_compact = False # optional. gettext_additional_targets = ['image'] # allows images to be translatable # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, project, propername, [author], 1) ] # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, project, propername, author, project, description, 'Manual'), ] # -- Options for Epub output ------------------------------------------------- # Bibliographic Dublin Core info. # filename # epub_basename = project.replace(' ', '_') + '_' + language epub_title = project+" "+version epub_description = description # Technically speaking dublincore accepts multiple author and contributor elements, but # the sphinx builder only accepts one. epub_author = author epub_publisher = author epub_copyright = copyright epub_cover = ('_static/images/manual_cover.png', '') # The unique identifier of the text. This can be a ISBN number # or the project homepage. # The above is false and perhaps a mistake in sphinx' documentation. # epub_uid maps to id, which is the dc identifier id # which in turn should be the used scheme. if os.getenv('BUILD_ID', None) is None: # There is no uniform resource name for git, but just randomly pasting a githash is bad form. epub_identifier = 'git:'+gitcommithash epub_uid = 'githash' if gitcommithash == release: epub_uid = 'release' # there's also no urn for releases, as technically some database thing should be used for that. epub_identifier = '_'.join(['Krita_Manual_Build', language, release]) else: epub_uid = 'url' epub_identifier = os.getenv('BUILD_URL', '') # Not actually used anywhere? Docs say that this should be what the epub uid is used for but... epub_scheme = 'URL' # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html', '.htaccess', '404.xhtml'] epub_tocscope = 'includehidden' # -- Extension configuration ------------------------------------------------- # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/reference_manual/tools/reference_images_tool.rst b/reference_manual/tools/reference_images_tool.rst index 54e3f5bc4..d2745546a 100644 --- a/reference_manual/tools/reference_images_tool.rst +++ b/reference_manual/tools/reference_images_tool.rst @@ -1,42 +1,48 @@ .. meta:: :description: The reference images tool .. metadata-placeholder :authors: - Wolthera van Hövell tot Westerflier :license: GNU free documentation license 1.3 or later. .. index:: Tools, Reference .. _reference_images_tool: ===================== Reference Images Tool ===================== +|toolreference| + .. versionadded:: 4.1 The reference images tool is a replacement for the reference images docker. You can use it to load images from your disk as reference, which can then be moved around freely on the canvas and placed wherever. Tool Options Add reference image Load a single image to display on the canvas. Load Set Load a set of reference images. Save Set Save a set of reference images. Delete all reference images Delete all the reference images Keep aspect ratio When toggled this will force the image to not get distorted. Opacity Lower the opacity. Saturation Desaturate the image. This is useful if you only want to focus on the light/shadow instead of getting distracted by the colors. Storage mode How is the reference image stored. Embed to \*.kra Store this reference image into the kra file. This is recommended for small vital files you'd easily lose track of otherwise. Link to external file. - Only link to the reference image, krita will open it from the disk everytime it loads this file. This is recommended for big files, or files that change a lot. \ No newline at end of file + Only link to the reference image, krita will open it from the disk everytime it loads this file. This is recommended for big files, or files that change a lot. + +You can move around reference images by selecting them with |mouseleft|, and dragging them. You can rotate reference images by holding the cursor close to the outside of the corners till the rotate cursor appears, while tilting is done by holding the cursor close to the outside of the middle nodes. Resizing can be done by dragging the nodes. You can delete a single reference image by clicking it and pressing 'del'. You can select multiple reference images with shift and perform all of these actions. + +To hide all reference images temporarily use :menuselection:`View --> Show Reference Images`. diff --git a/resources_page.rst b/resources_page.rst index 67c37d34a..fc919be78 100644 --- a/resources_page.rst +++ b/resources_page.rst @@ -1,136 +1,160 @@ .. meta:: :description: Resource Packs for Krita. .. metadata-placeholder :authors: - Wolthera van Hövell tot Westerflier - Scott Petrovic - Kamath Raghavendra - Nathan Lovato :license: GNU free documentation license 1.3 or later. .. _resources_page: ========= Resources ========= Brush Packs ----------- .. list-table:: * - .. figure:: /images/en/resource_packs/Resources-deevadBrushes.jpg :target: https://github.com/Deevad/deevad-krita-brushpresets David Revoy - .. figure:: /images/en/resource_packs/Resources-mirandaBrushes.jpg :target: http://www.ramonmiranda.com/2013/09/krita-training-vol-2-muses-dvd-preset.html Ramon Miranda - .. figure:: /images/en/resource_packs/Resources-conceptBrushes.jpg :target: https://forum.kde.org/viewtopic.php?f=274&t=127423 Concept art & Illustration Pack - .. figure:: /images/en/resource_packs/Resources-aldyBrushes.jpg :target: http://al-dy.deviantart.com/art/Aldys-Brush-Pack-for-Krita-196128561 Al-dy * - .. figure:: /images/en/resource_packs/Resources-meemodrawsBrushes.jpg :target: http://meemodraws.deviantart.com/art/Krita-Brush-Pack-311306611 Meemodraws - .. figure:: /images/en/resource_packs/Resources-cazuBrushes.jpg :target: http://www.pcazorla.com/2014/01/15/cazu-brush-collection-v2-for-krita/ Cazu Brush Collection - .. figure:: /images/en/resource_packs/Resources-stalcryBrushes.jpg :target: http://stalcry.deviantart.com/art/Krita-Custom-Brushes-350338351 Stalcry - .. figure:: /images/en/resource_packs/Resources-woltheraBrushes.jpg :target: https://forum.kde.org/viewtopic.php?f=274&t=125125 Wolthera * - .. figure:: /images/en/resource_packs/Resources-nylnook.jpg :target: http://nylnook.com/en/blog/krita-brushes-pack-v2/ Nylnook - .. figure:: /images/en/resource_packs/Resources-hushcoilBrushes.png :target: http://hushcoil.tumblr.com/kritabrushes/ Hushcoil - .. figure:: /images/en/resource_packs/Resources-raghukamathBrushes.png :target: https://github.com/raghukamath/krita-brush-presets Raghukamath - .. figure:: /images/en/resource_packs/Resources-GDQuestBrushes.jpeg :target: https://github.com/GDquest/free-krita-brushes/releases/ GDQuest * - .. figure:: /images/en/resource_packs/Resources-iForce73Brushes.png :target: https://www.deviantart.com/iforce73/art/Environments-2-0-759523252 Iforce73 - -- - - Texture Packs ------------- .. list-table:: * - .. figure:: /images/en/resource_packs/Resources-deevadTextures.jpg :target: https://www.davidrevoy.com/article156/texture-pack-1 David Revoy - .. figure:: /images/en/resource_packs/Resources-deevadTextures2.jpg :target: https://www.davidrevoy.com/article263/five-traditional-textures David Revoy External tutorials ------------------ .. list-table:: * - .. figure:: /images/en/resource_packs/simon_pixel_art_course.png :target: https://www.udemy.com/learn-to-create-pixel-art-from-zero/?couponCode=OTHER_75 Simón Sanchez' "Learn to Create Pixel Art from Zero" course on Udemy User-made Python Plugins ------------------- +------------------------ To install and manage your plugins, visit the :ref:`krita_python_plugin_howto` area. See the second area on how to get Krita to recognize your plugin. -**Direct Eraser Plugin** - http://www.mediafire.com/file/sotzc2keogz0bor/Krita+Direct+Eraser+Plugin.zip +Direct Eraser Plugin + + http://www.mediafire.com/file/sotzc2keogz0bor/Krita+Direct+Eraser+Plugin.zip + +Tablet Controls Docker + + https://github.com/tokyogeometry/tabui + +On-screen Canvas Shortcuts + + https://github.com/qeshi/henriks-onscreen-krita-shortcut-buttons/tree/master/henriks_krita_buttons + +Spine FIle Format Export + + https://github.com/chartinger/krita-unofficial-spine-export -**Tablet Controls Docker** - https://github.com/tokyogeometry/tabui +GDQuest - Designer Tools + + https://github.com/GDquest/Krita-designer-tools -**On-screen Canvas Shortcuts** - https://github.com/qeshi/henriks-onscreen-krita-shortcut-buttons/tree/master/henriks_krita_buttons +AnimLayers (Animate with Layers) -**Spine FIle Format Export** - https://github.com/chartinger/krita-unofficial-spine-export + https://github.com/thomaslynge/krita-plugins -**GDQuest - Designer Tools** - https://github.com/GDquest/Krita-designer-tools +Art Revision Control (using GIT) -**AnimLayers (Animate with Layers)** - https://github.com/thomaslynge/krita-plugins + https://github.com/abeimler/krita-plugin-durra -**Art Revision Control (using GIT)** - https://github.com/abeimler/krita-plugin-durra +Krita Plugin generator -**Krita Plugin generator** - https://github.com/cg-cnu/vscode-krita-plugin-generator + https://github.com/cg-cnu/vscode-krita-plugin-generator -**Bash Action (works with OSX and Linux)** - https://github.com/juancarlospaco/krita-plugin-bashactions#krita-plugin-bashactions +Bash Action (works with OSX and Linux) -**Reference Image Docker (old style)** - https://github.com/antoine-roux/krita-plugin-reference + https://github.com/juancarlospaco/krita-plugin-bashactions#krita-plugin-bashactions -**Post images on Mastadon** - https://github.com/spaceottercode/kritatoot +Reference Image Docker (old style) -**Python auto-complete for text editors** - https://github.com/scottpetrovic/krita-python-auto-complete + https://github.com/antoine-roux/krita-plugin-reference + +Post images on Mastadon + + https://github.com/spaceottercode/kritatoot + +Python auto-complete for text editors + + https://github.com/scottpetrovic/krita-python-auto-complete See Something We Missed? ------------ +------------------------ Have a resource you made and want to to share it with other artists? Let us know in the forum or visit our chat room to discuss getting the resource added to here.