From c7a058c308732ea6f0ba01f4343c4c8199f7ebb9 Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Fri, 10 Mar 2023 18:00:10 -0800 Subject: [PATCH] fix library paths in docs --- docs/guides/quickfort-library-guide.rst | 36 ++++++++++++------------- docs/guides/quickfort-user-guide.rst | 10 +++---- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/guides/quickfort-library-guide.rst b/docs/guides/quickfort-library-guide.rst index 74b384cc0..47d86cd4f 100644 --- a/docs/guides/quickfort-library-guide.rst +++ b/docs/guides/quickfort-library-guide.rst @@ -5,7 +5,7 @@ Quickfort blueprint library =========================== This guide contains a high-level overview of the blueprints available in the -:source:`quickfort blueprint library `. +:source:`quickfort blueprint library `. Each file is hyperlinked to its online version so you can see exactly what the blueprints do before you run them. Also, if you use `gui/quickfort`, you will @@ -18,8 +18,8 @@ Whole fort blueprint sets These files contain the plans for entire fortresses. Each file has one or more help sections that walk you through how to build the fort, step by step. -- :source:`library/dreamfort.csv ` -- :source:`library/quickfortress.csv ` +- :source:`library/dreamfort.csv ` +- :source:`library/quickfortress.csv ` .. _dreamfort: @@ -149,10 +149,10 @@ these ``#dig`` blueprints can only mark undug wall tiles for mining, they are best used underground. They won't do much on the surface, where there aren't many walls. -- :source:`library/layout-helpers/mark_up_left.csv ` -- :source:`library/layout-helpers/mark_up_right.csv ` -- :source:`library/layout-helpers/mark_down_right.csv ` -- :source:`library/layout-helpers/mark_down_left.csv ` +- :source:`library/layout-helpers/mark_up_left.csv ` +- :source:`library/layout-helpers/mark_up_right.csv ` +- :source:`library/layout-helpers/mark_down_right.csv ` +- :source:`library/layout-helpers/mark_down_left.csv ` Bedrooms -------- @@ -161,9 +161,9 @@ These are popular bedroom layouts from the :wiki:`Bedroom design` page on the wiki. Each file has ``#dig``, ``#build``, and ``#query`` blueprints to dig the rooms, build the furniture, and configure the beds as bedrooms, respectively. -- :source:`library/bedrooms/48-4-Raynard_Whirlpool_Housing.csv ` -- :source:`library/bedrooms/95-9-Hactar1_3_Branch_Tree.csv ` -- :source:`library/bedrooms/28-3-Modified_Windmill_Villas.csv ` +- :source:`library/bedrooms/48-4-Raynard_Whirlpool_Housing.csv ` +- :source:`library/bedrooms/95-9-Hactar1_3_Branch_Tree.csv ` +- :source:`library/bedrooms/28-3-Modified_Windmill_Villas.csv ` Tombs ----- @@ -171,8 +171,8 @@ Tombs These blueprints have burial plot layouts for fortress that expect a lot of casualties. -- :source:`library/tombs/Mini_Saracen.csv ` -- :source:`library/tombs/The_Saracen_Crypts.csv ` +- :source:`library/tombs/Mini_Saracen.csv ` +- :source:`library/tombs/The_Saracen_Crypts.csv ` Exploratory mining ------------------ @@ -181,18 +181,18 @@ Several mining patterns to choose from when searching for gems or ores. The patterns can be repeated up or down z-levels (via quickfort's ``--repeat`` commandline option) for exploring through the depths. -- :source:`library/exploratory-mining/tunnels.csv ` -- :source:`library/exploratory-mining/vertical-mineshafts.csv ` -- :source:`library/exploratory-mining/connected-mineshafts.csv ` +- :source:`library/exploratory-mining/tunnels.csv ` +- :source:`library/exploratory-mining/vertical-mineshafts.csv ` +- :source:`library/exploratory-mining/connected-mineshafts.csv ` Miscellaneous ------------- Extra blueprints that are useful in specific situations. -- :source:`library/aquifer_tap.csv ` -- :source:`library/embark.csv ` -- :source:`library/pump_stack.csv ` +- :source:`library/aquifer_tap.csv ` +- :source:`library/embark.csv ` +- :source:`library/pump_stack.csv ` Light aquifer tap ~~~~~~~~~~~~~~~~~ diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index ecee46918..ec416f18f 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -27,9 +27,9 @@ written by Joel Thornton, reused here with his permission. For those just looking to apply existing blueprints, check out the `quickfort command's documentation ` for syntax. There are also many -ready-to-use blueprints available in the ``blueprints/library`` subfolder in +ready-to-use blueprints available in the ``hack/data/blueprints`` subfolder in your DFHack installation. Browse them on your computer or -:source:`online `, or run `gui/quickfort` to browse +:source:`online `, or run `gui/quickfort` to browse and apply them to your fort! Before you become an expert at writing blueprints, though, you should know that @@ -248,7 +248,7 @@ You can save a lot of time and effort by using aliases instead of adding all key sequences directly to your blueprints. For more details, check out the `quickfort-alias-guide`. You can also see examples of aliases being used in the query blueprints in the -:source:`DFHack blueprint library `. You can create +:source:`DFHack blueprint library `. You can create your own aliases by adding them to :source:`dfhack-config/quickfort/aliases.txt` in your DFHack folder or you can package them `together with your blueprint files `. @@ -1467,7 +1467,7 @@ Dreamfort organization and packaging ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The Dreamfort blueprints are distributed with DFHack as -:source:`one large .csv file `, but +:source:`one large .csv file `, but editing in that format would be frustrating. Instead, the blueprints are edited `online as Google drive spreadsheets `__. @@ -1825,7 +1825,7 @@ Links - `blueprint-library-guide` - :forums:`Quickfort forum thread <176889>` - :issue:`DFHack issue tracker <>` -- :source:`Blueprint library source ` +- :source:`Blueprint library source ` - :source-scripts:`Quickfort source code ` **Related tools:**