Add refactoring.md and tweak virtual environments docs (take 2) (#341)

I took over - #265 rebased and made a tweak. This PR now only closes - #257 --- Questions that come to mind: - Do we even want a separate refactoring page any more? - Has anyone ever actually used rope? - Dev tools is now quite short. --------- Co-authored-by: ruaridhg <[email protected]> Co-authored-by: ruaridhg <[email protected]> Co-authored-by: David Stansby <[email protected]>
UCL-ARC · Mar 27, 2024 · dcda747 · dcda747
1 parent bdddd76
commit dcda747
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 9 deletions.
diff --git a/docs/pages/benchmarking.md → docs/pages/benchmarking-profiling.md b/docs/pages/benchmarking.md → docs/pages/benchmarking-profiling.md
diff --git a/docs/pages/refactoring.md b/docs/pages/refactoring.md
@@ -0,0 +1,12 @@
+---
+title: Refactoring tools
+layout: default
+---
+
+# Refactoring Tools
+
+| Name                                                        | Short description                                              | 🚦  |
+| ----------------------------------------------------------- | -------------------------------------------------------------- | --- |
+| [jedi](https://jedi.readthedocs.io/en/stable/)              | Refactoring and autocompletion used in IDEs.                   | 🟢  |
+| [sourcery.ai](https://sourcery.ai)                          | Refactoring suggestions and code review. Free for open source. | 🟠  |
+| [rope](https://rope.readthedocs.io/en/stable/overview.html) | Refactoring library.                                           | 🟠  |
diff --git a/docs/pages/utilities.md b/docs/pages/utilities.md
@@ -24,3 +24,9 @@ want to write these yourself but might need logging or a command-line interface.
 | --------------------------------------------------------- | -------------------------------------------------------------------- | :-: |
 | [loguru](https://loguru.readthedocs.io/)                  | Simple and user-friendly with many nice features enabled by default. | 🟢  |
 | [logging](https://docs.python.org/3/library/logging.html) | Python's builtin logging framework. Needs some configuration.        | 🟠  |
+
+## User interface
+
+| Name                                         | Short description       | 🚦  |
+| -------------------------------------------- | ----------------------- | :-: |
+| [tqdm](https://pypi.org/project/tqdm/2.2.3/) | Progress bar for loops. | 🟢  |
diff --git a/docs/pages/dev.md → docs/pages/virtual.md b/docs/pages/dev.md → docs/pages/virtual.md
@@ -1,5 +1,5 @@
 ---
-title: Dev tools
+title: Virtual environments
 layout: default
 ---
 
@@ -12,11 +12,3 @@ layout: default
 | [pyenv](https://github.com/pyenv/pyenv)                  | Lets you easily switch between multiple versions of Python.               | 🟠  |
 | [virtualenv](https://virtualenv.pypa.io/en/latest/)      | Creates isolated Python environments, and offers more features than venv. | 🟠  |
 | [venv](https://docs.python.org/3/library/venv.html)      | Creates isolated Python environments.                                     | 🔴  |
-
-# Other
-
-| Name                                                        | Short description                                                                      | 🚦  |
-| ----------------------------------------------------------- | -------------------------------------------------------------------------------------- | :-: |
-| [jedi](https://jedi.readthedocs.io/en/latest/)              | Refactoring and autocompletion used in for integrated development environments (IDEs). | 🟢  |
-| [rope](https://rope.readthedocs.io/en/latest/overview.html) | Refactoring library.                                                                   |     |
-| [tqdm](https://pypi.org/project/tqdm/2.2.3/)                | Progress bar for loops.                                                                | 🟢  |