You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* You don't need to specify the PyPI dependencies, they get inferred on the fly just from [`mkdocs.yml`] by doing a reverse lookup of MkDocs plugins in the [catalog], using [`properdocs get-deps`]. (See more details there)
72
+
* You don't need to specify the PyPI dependencies, they get inferred on the fly just from [`properdocs.yml`] by doing a reverse lookup of ProperDocs plugins in the [catalog], using [`properdocs get-deps`]. (See more details there)
73
73
74
-
* An automatically managed virtual environment with pre-defined MkDocs commands is at your fingertips.
74
+
* An automatically managed virtual environment with pre-defined ProperDocs commands is at your fingertips.
@@ -106,9 +106,9 @@ INFO - Documentation built in 0.03 seconds
106
106
107
107
</details>
108
108
109
-
(If you've been using virtualenvs directly, this single command replaces creating an environment, installing dependencies into it, as well as running `mkdocs` in it, optionally with arguments)
109
+
(If you've been using virtualenvs directly, this single command replaces creating an environment, installing dependencies into it, as well as running `properdocs` in it, optionally with arguments)
110
110
111
-
Furthermore, whenever the set of dependencies changes (i.e. you select new MkDocs plugins), these Hatch commands will re-install dependencies as necessary.
111
+
Furthermore, whenever the set of dependencies changes (i.e. you select new ProperDocs plugins), these Hatch commands will re-install dependencies as necessary.
112
112
Otherwise, the environment is just reused; the installation happens only on the first invocation.
113
113
114
114
If at any point you want to make sure the dependencies are re-installed anew, you can just remove the environment:
@@ -128,15 +128,15 @@ Just [install Hatch]. Ideally in an isolated way with **`pipx install hatch`** (
128
128
129
129
</details>
130
130
131
-
If you declare `hatch-mkdocs` as a dependency in your Hatch config (`pyproject.toml` or `hatch.toml`) as shown above, Hatch will automatically install it on first use.
131
+
If you declare `hatch-properdocs` as a dependency in your Hatch config (`pyproject.toml` or `hatch.toml`) as shown above, Hatch will automatically install it on first use.
132
132
133
-
Alternatively you can install it manually: `pipx inject hatch hatch-mkdocs` or just `pip install hatch-mkdocs`.
133
+
Alternatively you can install it manually: `pipx inject hatch hatch-properdocs` or just `pip install hatch-properdocs`.
134
134
135
-
And do *not* install MkDocs - it's unnecessary, only the sub-environments will have it.
135
+
And do *not* install ProperDocs - it's unnecessary, only the sub-environments will have it.
136
136
137
137
## Configuration
138
138
139
-
Note that although Hatch is typically associated with managing entire Python projects and applications, you *can* use it purely for environment management for a MkDocs site - through this plugin, or even without it.
139
+
Note that although Hatch is typically associated with managing entire Python projects and applications, you *can* use it purely for environment management for a ProperDocs site - through this plugin, or even without it.
140
140
141
141
Hatch can be configured through one of two files - `hatch.toml` or `pyproject.toml`. Configs in the latter are equivalent but will always need a `[tool.hatch...]` prefix; it can be used if you have an existing Python project and you don't want to add another config file.
142
142
@@ -148,11 +148,11 @@ So, add the following into one of the files:
148
148
```toml
149
149
[env]
150
150
requires = [
151
-
"hatch-mkdocs",
151
+
"hatch-properdocs",
152
152
]
153
153
154
-
[env.collectors.mkdocs.ENV_NAME]
155
-
path = "path/to/mkdocs.yml"
154
+
[env.collectors.properdocs.ENV_NAME]
155
+
path = "path/to/properdocs.yml"
156
156
157
157
[envs.ENV_NAME]
158
158
...
@@ -163,31 +163,31 @@ path = "path/to/mkdocs.yml"
163
163
```toml
164
164
[tool.hatch.env]
165
165
requires = [
166
-
"hatch-mkdocs"
166
+
"hatch-properdocs"
167
167
]
168
168
169
-
[tool.hatch.env.collectors.mkdocs.ENV_NAME]
170
-
path = "path/to/mkdocs.yml"
169
+
[tool.hatch.env.collectors.properdocs.ENV_NAME]
170
+
path = "path/to/properdocs.yml"
171
171
172
172
[tool.hatch.envs.ENV_NAME]
173
173
...
174
174
```
175
175
176
176
</td></tr></table>
177
177
178
-
Here, `[env.collectors.mkdocs.ENV_NAME]` means: please populate an environment named "ENV_NAME" based on an MkDocs config. In that section, `path` is the path to `mkdocs.yml`.
178
+
Here, `[env.collectors.properdocs.ENV_NAME]` means: please populate an environment named "ENV_NAME" based on an ProperDocs config. In that section, `path` is the path to `properdocs.yml`.
179
179
180
180
At the moment that is the entire configurability of this plugin.
181
181
182
-
In the first example we used "docs" as the environment name, you can use "mkdocs" as well if you like, or anything else. Further, if you use "default" as the name (which you might do if documentation building is all that you'll ever use Hatch for) then you can skip the environment prefix (`docs:` in the above example).
182
+
In the first example we used "docs" as the environment name, you can use "properdocs" as well if you like, or anything else. Further, if you use "default" as the name (which you might do if documentation building is all that you'll ever use Hatch for) then you can skip the environment prefix (`docs:` in the above example).
183
183
184
184
Multiple separate environments with their own configs and dependencies can be populated as well.
185
185
186
186
Inside `[envs.ENV_NAME]` (which is an ordinary construct in Hatch) you can proceed to further customize the environment (though normally it shouldn't be necessary, and the section can be omitted from the text config): you can add extra [`dependencies`] or [`scripts`], or any other environment config. You could also set [`detached`] back to `false` if the documentation actually relies on the project itself being installed, such as in the case of [mkdocstrings].
0 commit comments