Merge pull request #6075 from JustCris654/fix-docs

Fix path of /docs/ [ci skip]
opentripplanner · Sep 24, 2024 · 1c858c8 · 1c858c8
2 parents 9c10a0e + 1bc92c3
commit 1c858c8
Show file tree

Hide file tree

Showing 17 changed files with 23 additions and 22 deletions.
diff --git a/doc/templates/BuildConfiguration.md b/doc/templates/BuildConfiguration.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Graph Build Configuration

diff --git a/doc/templates/Configuration.md b/doc/templates/Configuration.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Configuring OpenTripPlanner

diff --git a/doc/templates/GraphQL-Tutorial.md b/doc/templates/GraphQL-Tutorial.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # GraphQL tutorial

diff --git a/doc/templates/RouteRequest.md b/doc/templates/RouteRequest.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Route Request

diff --git a/doc/templates/RouterConfiguration.md b/doc/templates/RouterConfiguration.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Router configuration

diff --git a/doc/templates/StopConsolidation.md b/doc/templates/StopConsolidation.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 # Stop consolidation
 

diff --git a/doc/templates/UpdaterConfig.md b/doc/templates/UpdaterConfig.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 

diff --git a/doc/user/BuildConfiguration.md b/doc/user/BuildConfiguration.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Graph Build Configuration

diff --git a/doc/user/Configuration.md b/doc/user/Configuration.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Configuring OpenTripPlanner

diff --git a/doc/user/Developers-Guide.md b/doc/user/Developers-Guide.md
@@ -56,7 +56,7 @@ There are several ways to get involved:
 * Join the [Gitter chat room](https://gitter.im/opentripplanner/OpenTripPlanner) and the 
   [user mailing list](http://groups.google.com/group/opentripplanner-users).
 
-* Fix typos and improve the documentation within the `/docs` directory of the project (details
+* Fix typos and improve the documentation within the `/doc/user` directory of the project (details
   below).
 
 * [File a bug or new feature request](http://github.com/openplans/OpenTripPlanner/issues/new).
@@ -133,7 +133,7 @@ control to be applied to documentation as well as program source code. All pull
 how OTP is used or configured should include changes to the documentation alongside code
 modifications.
 
-The documentation files are in Markdown format and are in the `/docs` directory under the root of
+The documentation files are in Markdown format and are in the `/doc/user` directory under the root of
 the project. On every push to the `dev-2.x` branch the documentation will be rebuilt and deployed as
 static pages to our subdomain of [Github Pages](https://github.com/opentripplanner/docs). 
 MkDocs is a Python program and should run on any major platform. 
@@ -143,7 +143,7 @@ how to generate a live local preview of the documentation while you're writing i
 In short:
 
 ```
-$ pip install -r docs/requirements.txt
+$ pip install -r doc/user/requirements.txt
 $ mkdocs serve
 ```
 

diff --git a/doc/user/RouteRequest.md b/doc/user/RouteRequest.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Route Request

diff --git a/doc/user/RouterConfiguration.md b/doc/user/RouterConfiguration.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # Router configuration

diff --git a/doc/user/UpdaterConfig.md b/doc/user/UpdaterConfig.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 

diff --git a/doc/user/apis/GraphQL-Tutorial.md b/doc/user/apis/GraphQL-Tutorial.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 
 # GraphQL tutorial

diff --git a/doc/user/sandbox/StopConsolidation.md b/doc/user/sandbox/StopConsolidation.md
@@ -2,7 +2,7 @@
   NOTE! Part of this document is generated. Make sure you edit the template, not the generated doc.
 
    - Template directory is:  /doc/templates
-   - Generated directory is: /docs 
+   - Generated directory is: /doc/user 
 -->
 # Stop consolidation
 

diff --git a/src/test/java/org/opentripplanner/generate/doc/framework/DocsTestConstants.java b/src/test/java/org/opentripplanner/generate/doc/framework/DocsTestConstants.java
@@ -14,19 +14,20 @@ public interface DocsTestConstants {
   File USER_DOC_PATH = new File(DOC_ROOT, "user");
 
   /**
-   * This method return {@code true} if the /docs directory is available. If not, a warning is
+   * This method return {@code true} if both the /doc/user and /doc/templates directories are available. If not, a warning is
    * logged and the method returns {@code false}. This is used by the {@link GeneratesDocumentation}
    * annotation.
    */
   static boolean docsExistOrWarn() {
-    if (USER_DOC_PATH.exists()) {
+    if (USER_DOC_PATH.exists() && TEMPLATE_PATH.exists()) {
       return true;
     }
+
     LOG.warn(
       """
-      SKIP TEST - '/docs' NOT FOUND
+      SKIP TEST - '/doc/user' or '/doc/templates' NOT FOUND
       
-          The doc/templates directory might not be available if you run the tests outside the
+          The /doc/user and /doc/templates directories might not be available if you run the tests outside the
           root of the projects. This may happen if the project root is not the working directory,
           if you run tests using jar files or in a Maven multi-module project.
           

diff --git a/src/test/java/org/opentripplanner/generate/doc/framework/GeneratesDocumentation.java b/src/test/java/org/opentripplanner/generate/doc/framework/GeneratesDocumentation.java
@@ -8,7 +8,7 @@
 import org.junit.jupiter.api.condition.EnabledIf;
 
 /**
- * Use this annotation on tests that generate(access) the /docs directory outside the
+ * Use this annotation on tests that generate(access) the /doc directory outside the
  * source/resource.
  * <p>
  * All tests annotated with this annotation is tagged with "docs". You may include or exclude