Capitalize H1s and H2s for better readability

ampl · Jan 22, 2025 · 2273762 · 2273762
1 parent f955926
commit 2273762
Show file tree

Hide file tree

Showing 18 changed files with 28 additions and 28 deletions.
diff --git a/docs/source/ampl/best-practices/style-guide.md b/docs/source/ampl/best-practices/style-guide.md
@@ -2,7 +2,7 @@
 
 Creating clear, consistent, and scalable AMPL models is critical for managing complex optimization workflows. The best practices identified in this guide provide actionable guidelines for naming, organizing, and formatting AMPL models to ensure readability, maintainability, and professional-quality output.
 
-## 1. Model structure
+## 1. Model Structure
 
 ### 1.1. Divide the model into clear sections
 
@@ -158,7 +158,7 @@ The most important rule for scalable models is to write descriptive and signific
     See more expressive modeling examples here: `Modeling guide <https://mp.ampl.com/model-guide.html>`_
 ```
 
-### 2.6. Objective functions
+### 2.6. Objective Functions
 
 - Name objectives starting each word with uppercase letters (PascalCase).
 - Action-Oriented: Use verbs or action-oriented phrases to describe the goal.
@@ -174,7 +174,7 @@ The most important rule for scalable models is to write descriptive and signific
 Remember that AMPL also supports [Multiple, Blended and Lexicographical objectives](https://mp.ampl.com/modeling-mo.html).
 ``` 
 
-## Benefits
+## 3. Benefits
 
 - ***Readability:*** Clear visual separation between different model elements.
 - ***Debugging:*** Easier to identify computed vs input elements.
@@ -183,7 +183,7 @@ Remember that AMPL also supports [Multiple, Blended and Lexicographical objectiv
 
 Adopting these best practices ensures clarity, consistency, and scalability in AMPL models. By following these guidelines, your models will be easier to read, maintain, and scale, achieving professional-quality optimization workflows. This structured approach enhances collaboration, simplifies debugging, and supports long-term usability, making your models highly effective and user-friendly.
 
-## How to use it
+## 4. How to Use It
 
 Just ask ChatGPT:
 - ***Please use these rules:*** https://dev.ampl.com/ampl/best-practices/style-guide.html

diff --git a/docs/source/ampl/books/anthony-papavasiliou/electricity-markets.md b/docs/source/ampl/books/anthony-papavasiliou/electricity-markets.md
@@ -13,7 +13,7 @@ Order your copy from [Cambridge University Press](https://www.cambridge.org/high
 
 Get up-to-speed with the fundamentals of how electricity markets are structured and operated with this comprehensive textbook, presenting coverage of key topics in electricity market design, including power system and power market operations, transmission, unit commitment, demand response, and risk management. It includes over 140 practical examples, inspired by real-industry applications, connecting key theoretical concepts to practical scenarios in electricity market design, and features over 100 coding-based examples and exercises, with selected solutions for readers. It further demonstrates how mathematical programming models are implemented in an industry setting. Requiring no experience in power systems or energy economics, this is the ideal introduction to electricity markets for senior undergraduate and graduate students in electrical engineering, economics, and operations research, and a robust introduction to the field for professionals in utilities, energy policy, and energy regulation. [Accompanied online by datasets, AMPL code, supporting videos, and full solutions and lecture slides for instructors.](https://www.cambridge.org/Papavasiliou)
 
-## Youtube videos
+## Youtube Videos
 
 - Chapter 1
     - [Chapter 1 (Introduction)](https://www.youtube.com/watch?v=Elk--NgW2ac)
@@ -35,7 +35,7 @@ Get up-to-speed with the fundamentals of how electricity markets are structured
 - Appendix
     - [Appendix B (The Direct Current Power Flow)](https://www.youtube.com/watch?v=sJ17WNjvuwY)
 
-## Slide decks
+## Slide Decks
 
 Slide decks corresponding to the chapters of the book are available [online](https://ap-rg.eu/courses/optimization-models-in-electricity-markets-book/).
 

diff --git a/docs/source/ampl/docker/index.md b/docs/source/ampl/docker/index.md
@@ -53,7 +53,7 @@ USER ${USERNAME}
  **Contact us at <[email protected]> for free deployment support.** You can also ask any questions you may have on our [Support Forum](https://discuss.ampl.com).
 ```
 
-## Other Docker containers
+## Other Docker Containers
 
 AMPL and solvers are also easy to use with Docke containers for languages other than Python.
 In this example, we use the image [`debian:stable-slim`](https://hub.docker.com/_/debian) as base image. We then use `curl` and `tar` for downloading and installing some [modules](https://ampl.com/dl/modules) that you may need.

diff --git a/docs/source/ampl/free.md b/docs/source/ampl/free.md
@@ -1,4 +1,4 @@
-# Get started for free
+# Get Started for Free
 
 AMPL offers several free options for users to develop and test optimization models.
 These options enable users to explore AMPL's capabilities and integrate them into 

diff --git a/docs/source/ampl/install.md b/docs/source/ampl/install.md
@@ -1,9 +1,9 @@
-# How to install AMPL
+# How to Install AMPL
 
 After downloading your AMPL & Solvers bundle from the [AMPL Portal](https://portal.ampl.com),
 please follow the instructions below that correspond to your operating system:
 
-- [How to install AMPL](#how-to-install-ampl)
+- [How to Install AMPL](#how-to-install-ampl)
   - [Google Colab](#google-colab)
   - [Python](#python)
   - [Windows](#windows)

diff --git a/docs/source/ampl/introduction.md b/docs/source/ampl/introduction.md
@@ -1,4 +1,4 @@
-# Quick introduction
+# Quick Introduction
 
 AMPL (A Mathematical Programming Language) is a high-level language for expressing optimization models. It is widely used in academia and industry to model and solve linear, nonlinear, and integer optimization problems.
 
@@ -91,7 +91,7 @@ param demand{PRODUCTS};
 param capacity{CITIES};
 ```
 
-### Decision variables
+### Decision Variables
 
 Decision variables represent the decisions you need to make in your model. For example, you might define a binary variable to represent whether a product is produced at a particular facility, or a continuous variable to represent the amount of a product that is produced.
 
@@ -103,7 +103,7 @@ var x{PRODUCTS, CITIES} binary;
 var y{PRODUCTS, PERIODS} >= 0;
 ```
 
-### Objective function
+### Objective Function
 
 The objective function defines the goal of your optimization model. For example, you might want to maximize profit, minimize cost, or maximize customer satisfaction.
 

diff --git a/docs/source/ampl/python/index.rst b/docs/source/ampl/python/index.rst
@@ -1,7 +1,7 @@
 
 .. _python_integration:
 
-AMPL integration with Python
+AMPL Integration with Python
 ============================
 
 .. image:: https://portal.ampl.com/dl/ads/python_ecosystem_horizontal.png
@@ -110,7 +110,7 @@ Check it out on Streamlit Cloud: |RunOnStreamlit|
 
 [`AMPL on Streamlit <https://ampl.com/streamlit>`_]
 
-See more
+See More
 ~~~~~~~~
 
 .. toctree::

diff --git a/docs/source/ampl/python/modules.md b/docs/source/ampl/python/modules.md
@@ -21,7 +21,7 @@ $ python
 
 [Python API (amplpy) Documentation](https://amplpy.ampl.com/)
 
-## Modules available
+## Modules Available
 
 List of modules available:
 
@@ -194,9 +194,9 @@ All of this is also available from Python programmatically:
 ['base', 'gurobi', 'highs']
 ```
 
-## How to use modules
+## How to Use Modules
 
-### Install modules
+### Install Modules
 
 ```bash
 # Install Python API for AMPL

diff --git a/docs/source/ampl/python/pyinstaller.md b/docs/source/ampl/python/pyinstaller.md
@@ -1,5 +1,5 @@
 (amplpy.bundle)=
-# PyInstaller bundles
+# PyInstaller Bundles
 
 [PyInstaller](https://pyinstaller.org/) is a popular tool in the Python ecosystem used to convert Python applications into standalone executables. It's beneficial when you want to distribute your Python code as a single package, making it easier for users who might not have Python or the required dependencies installed.
 

diff --git a/docs/source/ampl/python/streamlit.md b/docs/source/ampl/python/streamlit.md
@@ -20,7 +20,7 @@ ampl = AMPL()
 - [Python API documentation](https://amplpy.ampl.com)
 - [Python modules documentation](modules.md)
 
-## N-Queens using AMPL and HiGHS
+## N-Queens Using AMPL and HiGHS
 
 - Running on Streamlit Cloud: [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/fdabrandao/streamlit-nqueens/)
 - Project GitHub: <https://github.com/fdabrandao/streamlit-nqueens>

diff --git a/docs/source/help/floating-licenses/configuration.md b/docs/source/help/floating-licenses/configuration.md
@@ -1,4 +1,4 @@
-# Floating license configuration guide
+# Floating License Configuration Guide
 
 ```{note}
 This page explains how to change the default configuration of the AMPL floating license manager, to handle various special situations.

diff --git a/docs/source/help/floating-licenses/index.md b/docs/source/help/floating-licenses/index.md
@@ -1,4 +1,4 @@
-# Legacy floating license manager
+# Legacy Floating License Manager
 
 AMPL offers a **floating license** facility that lets you share one or several AMPL and solver licenses over a greater number of computers and users.
 

diff --git a/docs/source/help/floating-licenses/installation.md b/docs/source/help/floating-licenses/installation.md
@@ -1,4 +1,4 @@
-# Floating license installation guide
+# Floating License Installation Guide
 
 ```{note}
 This page introduces AMPL floating licenses and gives instructions for initial installation.

diff --git a/docs/source/help/floating-licenses/manager.md b/docs/source/help/floating-licenses/manager.md
@@ -1,4 +1,4 @@
-# Floating license manager guide
+# Floating License Manager Guide
 
 ```{note}
 This page explains how to run the floating license manager `ampl_lic` and related programs, to start serving floating licenses and to manage their use.

diff --git a/docs/source/help/floating-licenses/troubleshooting.md b/docs/source/help/floating-licenses/troubleshooting.md
@@ -1,4 +1,4 @@
-# Floating license troubleshooting guide
+# Floating License Troubleshooting Guide
 
 ```{note}
 This page explains how to interpret the AMPL floating license manager’s informational and error messages, and how to request additional help with configuration and connection problems.

diff --git a/docs/source/help/get-fingerprint.md b/docs/source/help/get-fingerprint.md
@@ -1,4 +1,4 @@
-# Fingerprint instructions for static licenses
+# Fingerprint Instructions for Static Licenses
 
 Some AMPL licenses require a license file that is tied to a particular computer. Before we can generate this license file, we need you to run our "fingerprint" program on your computer that will host AMPL, and to send us the resulting output.
 

diff --git a/docs/source/more/index.md b/docs/source/more/index.md
@@ -1,6 +1,6 @@
 (more)=
 
-# Learn more
+# Learn More
 
 ```{toctree}
 :hidden:

diff --git a/docs/source/more/new.md b/docs/source/more/new.md
@@ -1,5 +1,5 @@
 (what_is_new)=
-# What's new?
+# What's New?
 
 ## New book: Hands-On Mathematical Optimization with AMPL in Python