diff --git a/.htaccess b/.htaccess index 93272d592..6973a2832 100644 --- a/.htaccess +++ b/.htaccess @@ -1,328 +1,328 @@ RewriteEngine on RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-l -RewriteRule "^(.*)" 404.html [NC,L] +RewriteRule "^(.*)" 404.php [NC,L] # Old mediawiki pages redirects. RewriteBase /en RewriteRule "^Main_Page" index.html [R=301] RewriteRule "^KritaFAQ$" KritaFAQ.html [R=301] RewriteRule "^Contributors_Readme" contributors_manual/krita_manual_readme.html [R=301] RewriteRule "^Resources" resources_page.html [R=301] # User Manual RewriteRule "^Category:User_Manual" user_manual.html [R=301] RewriteRule "^Drawing_Tablets" user_manual/drawing_tablets.html [R=301] RewriteRule "^Loading_and_Saving_Brushes" user_manual/loading_saving_brushes.html [R=301] RewriteRule "^On_Canvas_Brush_Editor" user_manual/oncanvas_brush_editor.html [R=301] RewriteRule "^Mirror_Tools" user_manual/mirror_tools.html [R=301] RewriteRule "^Painting_With_Assistants" user_manual/painting_with_assistants.html [R=301] RewriteRule "^Working_with_Images" user_manual/working_with_images.html [R=301] RewriteRule "^Templates" user_manual/templates.html [R=301] RewriteRule "^Introduction_to_Layers_and_Masks" user_manual/layers_and_masks.html [R=301] RewriteRule "^Selections" user_manual/selections.html [R=301] RewriteRule "^Tag_System" user_manual/tag_management.html [R=301] RewriteRule "^Soft_Proofing" user_manual/soft_proofing.html [R=301] RewriteRule "^Vector_Graphics" user_manual/vector_graphics.html [R=301] RewriteRule "^Snapping" user_manual/snapping.html [R=301] RewriteRule "^Animation" user_manual/animation.html [R=301] RewriteRule "^Japanese_Animation_Template_for_Krita" user_manual/japanese_animation_template.html [R=301] # Getting started RewriteRule "^Category:Getting_Started" user_manual/getting_started.html [R=301] RewriteRule "^Installation" user_manual/getting_started/installation.html [R=301] RewriteRule "^Starting_Krita" user_manual/getting_started/starting_krita.html [R=301] RewriteRule "^Basic_Concepts" user_manual/getting_started/basic_concepts.html [R=301] RewriteRule "^Navigation" user_manual/getting_started/navigation.html [R=301] # Introduction RewriteRule "^Category:Introduction_coming_from_other_software" user_manual/introduction_from_other_software.html [R=301] RewriteRule "^Introduction_to_Krita_coming_from_Photoshop" user_manual/introduction_from_other_software/introduction_from_photoshop.html [R=301] RewriteRule "^Introduction_to_Krita_coming_from_Painttool_Sai" user_manual/introduction_from_other_software/introduction_from_sai.html [R=301] # Python Scripting RewriteRule "^Category:Python_Scripting" user_manual/python_scripting.html [R=301] RewriteRule "^Introduction_to_Python_Scripting" user_manual/python_scripting/introduction_to_python_scripting.html [R=301] RewriteRule "^How_to_make_a_Krita_Python_plugin" user_manual/python_scripting/krita_python_plugin_howto.html [R=301] # Reference Manual RewriteRule "^Category:Reference_Manual" reference_manual.html [R=301] RewriteRule "^Blending_Modes" reference_manual/blending_modes.html [R=301] RewriteRule "^Dr._Mingw_debugger" reference_manual/dr_minw_debugger.html [R=301] RewriteRule "^Instant_Preview" reference_manual/instant_preview.html [R=301] RewriteRule "^The_Krita_4_Preset_Bundle" reference_manual/krita_4_preset_bundle.html [R=301] RewriteRule "^Linux_Command_Line" reference_manual/linux_command_line.html [R=301] RewriteRule "^List_of_Tablets_Supported" reference_manual/list_supported_tablets.html [R=301] RewriteRule "^Maths_input" reference_manual/maths_input.html [R=301] RewriteRule "^Render_Animation" reference_manual/render_animation.html [R=301] RewriteRule "^Stroke_Selection" reference_manual/stroke_selection.html [R=301] # Brushes RewriteRule "^Category:Brushes" reference_manual/brushes.html [R=301] # Brush Engines RewriteRule "^Category:Brush_Engines" reference_manual/brushes/brush_engines.html [R=301] RewriteRule "^Bristle" reference_manual/brushes/brush_engines/bristle_engine.html [R=301] RewriteRule "^Chalk" reference_manual/brushes/brush_engines/chalk_engine.html [R=301] RewriteRule "^Clone" reference_manual/brushes/brush_engines/clone_engine.html [R=301] RewriteRule "^Color_Smudge" reference_manual/brushes/brush_engines/color_smudge_engine.html [R=301] RewriteRule "^Curve" reference_manual/brushes/brush_engines/curve_engine.html [R=301] RewriteRule "^Deform" reference_manual/brushes/brush_engines/deform_brush_engine.html [R=301] RewriteRule "^Dyna" reference_manual/brushes/brush_engines/dyna_brush_engine.html [R=301] RewriteRule "^Filter" reference_manual/brushes/brush_engines/filter_brush_engine.html [R=301] RewriteRule "^Grid" reference_manual/brushes/brush_engines/grid_brush_engine.html [R=301] RewriteRule "^Hatching" reference_manual/brushes/brush_engines/hatching_brush_engine.html [R=301] RewriteRule "^Particle" reference_manual/brushes/brush_engines/particle_brush_engine.html [R=301] RewriteRule "^Pixel" reference_manual/brushes/brush_engines/pixel_brush_engine.html [R=301] RewriteRule "^Quick_Brush" reference_manual/brushes/brush_engines/quick_brush_engine.html [R=301] RewriteRule "^Shape" reference_manual/brushes/brush_engines/shape_brush_engine.html [R=301] RewriteRule "^Sketch" reference_manual/brushes/brush_engines/sketch_brush_engine.html [R=301] RewriteRule "^Spray" reference_manual/brushes/brush_engines/spray_brush_engine.html [R=301] RewriteRule "^Tangent_Normal" reference_manual/brushes/brush_engines/tangen_normal_brush_engine.html [R=301] # Brush Settings RewriteRule "^Category:Brush_Settings" reference_manual/brushes/brush_settings.html [R=301] RewriteRule "^Brush_Tips" reference_manual/brushes/brush_settings/brush_tips.html [R=301] RewriteRule "^Locked_Brush_Settings" reference_manual/brushes/brush_settings/locked_brush_settings.html [R=301] RewriteRule "^Masked_Brush" reference_manual/brushes/brush_settings/masked_brush.html [R=301] RewriteRule "^Opacity_&_Flow" reference_manual/brushes/brush_settings/opacity_and_flow.html [R=301] RewriteRule "^Parameters" reference_manual/brushes/brush_settings/options.html [R=301] RewriteRule "^Sensors" reference_manual/brushes/brush_settings/tablet_sensors.html [R=301] RewriteRule "^Texture" reference_manual/brushes/brush_settings/texture.html [R=301] # Dockers RewriteRule "^Category:Dockers" reference_manual/dockers.html [R=301] RewriteRule "^Add_Shape" reference_manual/dockers/add_shape.html [R=301] RewriteRule "^Advanced_Color_Selector" reference_manual/dockers/advanced_color_selector.html [R=301] RewriteRule "^Animation_Curves" reference_manual/dockers/animation_curve.html [R=301] RewriteRule "^Animation_Docker" reference_manual/dockers/animation_docker.html [R=301] RewriteRule "^Artistic_Color_Selector" reference_manual/dockers/artistic_color_selector.html [R=301] RewriteRule "^Brush_Presets" reference_manual/dockers/brush_preset_docker.html [R=301] RewriteRule "^Channels" reference_manual/dockers/channels_docker.html [R=301] RewriteRule "^Color_Sliders" reference_manual/dockers/color_sliders.html [R=301] RewriteRule "^Compositions" reference_manual/dockers/compositions.html [R=301] RewriteRule "^Digital_Color_Mixer" reference_manual/dockers/digital_color_mixer.html [R=301] RewriteRule "^Grids_and_Guides" reference_manual/dockers/grids_and_guides.html [R=301] RewriteRule "^Histogram" reference_manual/dockers/histogram_docker.html [R=301] RewriteRule "^Layers" reference_manual/dockers/layers.html [R=301] RewriteRule "^LUT_Management" reference_manual/dockers/lut_management.html [R=301] RewriteRule "^Onion_Skin_Docker" reference_manual/dockers/onion_skin.html [R=301] RewriteRule "^Overview" reference_manual/dockers/overview.html [R=301] RewriteRule "^Palette" reference_manual/dockers/palette_docker.html [R=301] RewriteRule "^Patterns" reference_manual/dockers/pattern_docker.html [R=301] RewriteRule "^Reference_Images" reference_manual/dockers/reference_images_docker.html [R=301] RewriteRule "^Shape_Properties" reference_manual/dockers/shape_properties_docker.html [R=301] RewriteRule "^Small_Color_Selector" reference_manual/dockers/small_color_selector.html [R=301] RewriteRule "^Snap_Settings" reference_manual/dockers/snap_settings_docker.html [R=301] RewriteRule "^Specific_Color_Selector" reference_manual/dockers/specific_color_selector.html [R=301] RewriteRule "^Task_Sets" reference_manual/dockers/task_sets.html [R=301] RewriteRule "^Timeline_Docker" reference_manual/dockers/timeline.html [R=301] RewriteRule "^Touch_Docker" reference_manual/dockers/touch_docker.html [R=301] RewriteRule "^Undo_History" reference_manual/dockers/undo_history.html [R=301] RewriteRule "^Vector_Library_Docker" reference_manual/dockers/vector_library.html [R=301] # Filters RewriteRule "^Category:Filters" reference_manual/filters.html [R=301] RewriteRule "^Adjust" reference_manual/filters/adjust.html [R=301] RewriteRule "^Artistic" reference_manual/filters/artistic.html [R=301] RewriteRule "^Blur" reference_manual/filters/blur.html [R=301] RewriteRule "^Colors" reference_manual/filters/colors.html [R=301] RewriteRule "^Edge_Detection" reference_manual/filters/edge_detection.html [R=301] RewriteRule "^Emboss" reference_manual/filters/emboss.html [R=301] RewriteRule "^Enhance" reference_manual/filters/enhance.html [R=301] RewriteRule "^Map" reference_manual/filters/map.html [R=301] RewriteRule "^Other_filters" reference_manual/filters/other.html [R=301] RewriteRule "^Wavelet_decompose" reference_manual/filters/wavelet_decompose.html [R=301] # Layers RewriteRule "^Category:Layers_and_Masks" reference_manual/layers_and_masks.html [R=301] RewriteRule "^Clone_layers" reference_manual/layers_and_masks/clone_layers.html [R=301] RewriteRule "^File_Layers" reference_manual/layers_and_masks/file_layers.html [R=301] RewriteRule "^Fill_Layers" reference_manual/layers_and_masks/fill_layers.html [R=301] RewriteRule "^Filter_Layers" reference_manual/layers_and_masks/filter_layers.html [R=301] RewriteRule "^Filter_Masks" reference_manual/layers_and_masks/filter_masks.html [R=301] RewriteRule "^Group_Layers" reference_manual/layers_and_masks/group_layers.html [R=301] RewriteRule "^Layer_Styles" reference_manual/layers_and_masks/layer_styles.html [R=301] RewriteRule "^Paint_Layers" reference_manual/layers_and_masks/paint_layers.html [R=301] RewriteRule "^Local_Selection_Masks" reference_manual/layers_and_masks/selection_masks.html [R=301] RewriteRule "^Transformation_Masks" reference_manual/layers_and_masks/transformation_masks.html [R=301] RewriteRule "^Transparency_Masks" reference_manual/layers_and_masks/transparency_masks.html [R=301] RewriteRule "^Vector_Layers" reference_manual/layers_and_masks/vector_layers.html [R=301] # Menu RewriteRule "^Category:Main_Menu" reference_manual/main_menu.html [R=301] RewriteRule "^Edit_Menu" reference_manual/main_menu/edit_menu.html [R=301] RewriteRule "^File_Menu" reference_manual/main_menu/file_menu.html [R=301] RewriteRule "^Help_Menu" reference_manual/main_menu/help_menu.html [R=301] RewriteRule "^Image_Menu" reference_manual/main_menu/image_menu.html [R=301] RewriteRule "^Layer_Menu" reference_manual/main_menu/layers_menu.html [R=301] RewriteRule "^Select_Menu" reference_manual/main_menu/select_menu.html [R=301] RewriteRule "^Settings_Menu" reference_manual/main_menu/settings_menu.html [R=301] RewriteRule "^Tools_Menu" reference_manual/main_menu/tools_menu.html [R=301] RewriteRule "^View_Menu" reference_manual/main_menu/view_menu.html [R=301] RewriteRule "^Window_Menu" reference_manual/main_menu/window_menu.html [R=301] # Preferences RewriteRule "^Category:Preferences" reference_manual/preferences.html [R=301] RewriteRule "^Author_Settings" reference_manual/preferences/author_settings.html [R=301] RewriteRule "^Canvas_Input_Settings" reference_manual/preferences/canvas_input_settings.html [R=301] RewriteRule "^Canvas-only_Settings" reference_manual/preferences/canvas_only_mode.html [R=301] RewriteRule "^Color_Management_Settings" reference_manual/preferences/color_management_settings.html [R=301] RewriteRule "^Color_Selector_Settings" reference_manual/preferences/color_selector_settings.html [R=301] RewriteRule "^Display_Settings" reference_manual/preferences/display_settings.html [R=301] RewriteRule "^GMIC_filter_plugin" reference_manual/preferences/g_mic_settings.html [R=301] RewriteRule "^General_Settings" reference_manual/preferences/general_settings.html [R=301] RewriteRule "^Grid_Settings" reference_manual/preferences/grid_settings.html [R=301] RewriteRule "^Performance_Settings" reference_manual/preferences/performance_settings.html [R=301] RewriteRule "^Python_Plugin_Manager" reference_manual/preferences/python_plugin_manager.html [R=301] RewriteRule "^Shortcuts" reference_manual/preferences/shortcut_settings.html [R=301] RewriteRule "^Tablet_Settings" reference_manual/preferences/tablet_settings.html [R=301] # Resources RewriteRule "^Category:Resource_Management" reference_manual/resource_management.html [R=301] RewriteRule "^Managing_Brush_Presets" reference_manual/resource_management/paintoppresets.html [R=301] RewriteRule "^Managing_Brush_Tips" reference_manual/resource_management/resource_brushtips.html [R=301] RewriteRule "^Managing_Gradients" reference_manual/resource_management/resource_gradients.html [R=301] RewriteRule "^Managing_Patterns" reference_manual/resource_management/resource_patterns.html [R=301] RewriteRule "^Managing_Workspaces" reference_manual/resource_management/resource_workspace.html [R=301] # Tools RewriteRule "^Category:Toolbox" reference_manual/tools.html [R=301] RewriteRule "^Shape_Selection_Tool" reference_manual/tools/shape_selection.html [R=301] RewriteRule "^Shape_Handling_Tool" reference_manual/tools/shape_selection.html [R=301] RewriteRule "^Edit_Shapes_Tool" reference_manual/tools/shape_edit.html [R=301] RewriteRule "^Text_Tool" reference_manual/tools/text.html [R=301] RewriteRule "^Gradient_Editing_Tool" reference_manual/tools/gradient_edit.html [R=301] RewriteRule "^Pattern_Editing_Tool" reference_manual/tools/pattern_edit.html [R=301] RewriteRule "^Calligraphy" reference_manual/tools/calligraphy.html [R=301] RewriteRule "^Freehand_Brush_Tool" reference_manual/tools/freehand_brush.html [R=301] RewriteRule "^Straight_Line_Tool" reference_manual/tools/line.html [R=301] RewriteRule "^Rectangle_Tool" reference_manual/tools/rectangle.html [R=301] RewriteRule "^Ellipse_Tool" reference_manual/tools/ellipse.html [R=301] RewriteRule "^Polygon_Tool" reference_manual/tools/polygon.html [R=301] RewriteRule "^Polyline_Tool" reference_manual/tools/polyline.html [R=301] RewriteRule "^Path_Tool" reference_manual/tools/path.html [R=301] RewriteRule "^Freehand_Path_Tool" reference_manual/tools/freehand_path.html [R=301] RewriteRule "^Dynamic_Brush_Tool" reference_manual/tools/dyna.html [R=301] RewriteRule "^Multibrush_Tool" reference_manual/tools/multibrush.html [R=301] RewriteRule "^Crop_Tool" reference_manual/tools/crop.html [R=301] RewriteRule "^Move_Tool" reference_manual/tools/move.html [R=301] RewriteRule "^Transform_Tool" reference_manual/tools/transform.html [R=301] RewriteRule "^Measure_Tool" reference_manual/tools/measure.html [R=301] RewriteRule "^Fill_Tool" reference_manual/tools/fill.html [R=301] RewriteRule "^Gradient_Tool" reference_manual/tools/gradient_draw.html [R=301] RewriteRule "^Color_Selector_Tool" reference_manual/tools/color_selector.html [R=301] RewriteRule "^Colorize_Mask" reference_manual/tools/colorize_mask.html [R=301] RewriteRule "^Lazy_Brush" reference_manual/tools/colorize_mask.html [R=301] RewriteRule "^Grid_Tool" reference_manual/tools/grid_tool.html [R=301] RewriteRule "^Perspective_Grid_Tool" reference_manual/tools/perspective_grid.html [R=301] RewriteRule "^Smart_Patch_Tool" reference_manual/tools/smart_patch.html [R=301] RewriteRule "^Assistant_Tool" reference_manual/tools/assistant.html [R=301] RewriteRule "^Rectangular_Selection_Tool" reference_manual/tools/rectangular_select.html [R=301] RewriteRule "^Elliptical_Selection_Tool" reference_manual/tools/elliptical_select.html [R=301] RewriteRule "^Outline_Selection_Tool" reference_manual/tools/outline_select.html [R=301] RewriteRule "^Polygonal_Selection_Tool" reference_manual/tools/polygonal_select.html [R=301] RewriteRule "^Contiguous_Selection_Tool" reference_manual/tools/contiguous_select.html [R=301] RewriteRule "^Bezier_Curve_Selection_Tool" reference_manual/tools/path_select.html [R=301] RewriteRule "^Similar_Color_Selection_Tool" reference_manual/tools/similar_select.html [R=301] RewriteRule "^Zoom_Tool" reference_manual/tools/zoom.html [R=301] RewriteRule "^Pan_Tool" reference_manual/tools/pan.html [R=301] # General Concepts RewriteRule "^Category:General_Concepts" general_concepts.html [R=301] # Color RewriteRule "^Category:Color" general_concepts/colors.html [R=301] RewriteRule "^Bit_Depth" general_concepts/colors/bit_depth.html [R=301] RewriteRule "^Color_Managed_Workflow" general_concepts/colors/color_managed_workflow.html [R=301] RewriteRule "^Mixing_Colors" general_concepts/colors/color_mixing.html [R=301] RewriteRule "^Color_Models" general_concepts/colors/color_models.html [R=301] RewriteRule "^Color_space_size" general_concepts/colors/color_space_size.html [R=301] RewriteRule "^Gamma_and_Linear" general_concepts/colors/linear_and_gamma.html [R=301] RewriteRule "^Profiling_and_Calibration" general_concepts/colors/profiling_and_callibration.html [R=301] RewriteRule "^Scene_Linear_Painting" general_concepts/colors/scene_linear_painting.html [R=301] RewriteRule "^Viewing_Conditions" general_concepts/colors/viewing_conditions.html [R=301] # File Formats RewriteRule "^Category:File_Formats" general_concepts/file_formats.html [R=301] RewriteRule "^\*.bmp" general_concepts/file_formats/file_bmp.html [R=301] RewriteRule "^\*.csv" general_concepts/file_formats/file_csv.html [R=301] RewriteRule "^\*.exr" general_concepts/file_formats/file_exr.html [R=301] RewriteRule "^\*.gbr" general_concepts/file_formats/file_gbr.html [R=301] RewriteRule "^\*.gif" general_concepts/file_formats/file_gif.html [R=301] RewriteRule "^\*.gih" general_concepts/file_formats/file_gih.html [R=301] RewriteRule "^\*.jpg" general_concepts/file_formats/file_jpeg.html [R=301] RewriteRule "^\*.kpl" general_concepts/file_formats/file_kpl.html [R=301] RewriteRule "^\*.kra" general_concepts/file_formats/file_kra.html [R=301] RewriteRule "^\*.ora" general_concepts/file_formats/file_ora.html [R=301] RewriteRule "^\*.pbm" general_concepts/file_formats/file_pbgpm.html [R=301] RewriteRule "^\*.pgm" general_concepts/file_formats/file_pbgpm.html [R=301] RewriteRule "^\*.ppm" general_concepts/file_formats/file_pbgpm.html [R=301] RewriteRule "^\*.pdf" general_concepts/file_formats/file_pdf.html [R=301] RewriteRule "^\*.png" general_concepts/file_formats/file_png.html [R=301] RewriteRule "^\*.psd" general_concepts/file_formats/file_psd.html [R=301] RewriteRule "^\*.svg" general_concepts/file_formats/file_svg.html [R=301] RewriteRule "^\*.tiff" general_concepts/file_formats/file_tif.html [R=301] # Projection RewriteRule "^Category:Projection" general_concepts/projection.html [R=301] RewriteRule "^Projection:_Orthographic_and_Oblique" general_concepts/projection/orthographic_oblique.html [R=301] RewriteRule "^Projection:_Axonometric" general_concepts/projection/axonometric.html [R=301] RewriteRule "^Projection:_Perspective" general_concepts/projection/perspective.html [R=301] RewriteRule "^Projection:_Practical_Uses" general_concepts/projection/practical.html [R=301] # Tutorials RewriteRule "^Category:Tutorials" tutorials.html [R=301] RewriteRule "^Clipping_Masks_and_Alpha_Inheritance" tutorials/clipping_masks_and_alpha_inheritance.html [R=301] RewriteRule "^Common-workflows" tutorials/common_workflows.html [R=301] RewriteRule "^Flat_Coloring" tutorials/flat-coloring.html [R=301] RewriteRule "^Inking" tutorials/inking.html [R=301] RewriteRule "^Saving_for_the_Web" tutorials/saving-for-the-web.html [R=301] RewriteRule "^Making_an_Azalea_with_the_transformation_masks" tutorials/making_an_azalea_with_the_transformation_masks.html [R=301] # RewriteRule "^External_Training_and_Tutorials RewriteRule "^Brush-tips:Animated_Brush" tutorials/krita-brush-tips/animated_brushes.html [R=301] RewriteRule "^Brush-tips:Bokeh" tutorials/krita-brush-tips/bokeh-brush.html [R=301] RewriteRule "^Brush-tips:Caustics" tutorials/krita-brush-tips/caustics.html [R=301] RewriteRule "^Brush-tips:Fur" tutorials/krita-brush-tips/fur.html [R=301] RewriteRule "^Brush-tips:Hair" tutorials/krita-brush-tips/hair.html [R=301] RewriteRule "^Brush-tips:Outline" tutorials/krita-brush-tips/outline.html [R=301] RewriteRule "^Brush-tips:Rainbow_Brush" tutorials/krita-brush-tips/rainbow-brush.html [R=301] RewriteRule "^Brush-tips:Sculpt-paint-brush" tutorials/krita-brush-tips/sculpt-paint-brush.html [R=301] diff --git a/404.php b/404.php new file mode 100644 index 000000000..4a8e87d88 --- /dev/null +++ b/404.php @@ -0,0 +1,4 @@ + diff --git a/conf.py b/conf.py index d0b402590..50ab767d3 100644 --- a/conf.py +++ b/conf.py @@ -1,342 +1,342 @@ # -*- 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.0' # The full version, including alpha/beta/rc tags release = '4.0.3' # -- 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'] # copy over .htaccess file to each langaguge +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 """ # -- 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_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # 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'), ] # -- 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}