Documentation: Build fixes (#5)

* Docs: Build fixes

* remove pycache

* docs: build fixes

mkdocs-base.yml

@@ -51,6 +51,7 @@ nav:
                         - user/quickstart/index.md
                 - Guide:
                         - user/guide/index.md
+                        - Creating Your Account: user/guide/creating-your-account.md
                         - Creating Projects: user/guide/creating-projects.md
                         - Creating Indicators: user/guide/indicator-page.md
                         - Indicator Layers: user/guide/indicator-layers.md
@@ -66,6 +67,7 @@ nav:
                         - Access Requests: user/guide/access-request-guide.md
                         - Project Page: user/guide/project-page.md
                         - Share Page: user/guide/share.md 
+                        - "": user/guide/API_Documentation.md
                 - Manual: 
                         - user/manual/index.md
                         - Home Page: user/manual/home.md
@@ -85,6 +87,7 @@ nav:
                         - Logs: user/manual/logs.md
                         - Users and Groups: user/manual/users-and-groups.md
                         - PDF User Guide: user/manual/GeoSight User Guide.pdf
+                        - "": user/manual/date-and-time.md
         - Administrators:
                 - administrator/index.md
                 - Guide:
@@ -101,6 +104,7 @@ nav:
                         - IDE Setup: developer/guide/ide-setup.md
                         - Configuration: developer/guide/configuration.md
                         - Building: developer/guide/building.md
+                        - Removing: developer/guide/removing.md
                         - Design: developer/guide/design.md
                         - Road Map: developer/guide/roadmap.md
                         - Testing: developer/guide/testing.md

src/developer/documentation/overview.md

@@ -82,40 +82,40 @@ Please follow these conventions when writing your documentation:
 To start adding to the documentation navigate to the [home page](https://github.com/unicef-drp/GeoRepo-OS) of the repository.
 
 Once on the repository home page, 1️⃣ click on Fork
-![Fork Repository 1](img/dev-docs-fork-repo-1.png)
+![Fork Repository 1](img/fork-repo-1.png)
 
 On the next page 1️⃣ Make sure your github account is selected as the owner and 2️⃣ make sure the "**Copy the** `main` **branch only**" option is ticked as you will only need the main branch.
-![Fork Repository 2](img/dev-docs-fork-repo-2.png)
+![Fork Repository 2](img/fork-repo-2.png)
 
 Once you have forked the repository, ensure that you are working in the main branch.
-![Change Branch](img/dev-docs-check-branch.png)
+![Change Branch](img/check-branch.png)
 
 Once you are in your fork of the repository, click on `.` on your keyboard. This will open a web editor where you can begin adding to, or editing, the documentation.
-![Web Editor 1](img/dev-docs-web-editor-1.png)
+![Web Editor 1](img/web-editor-1.png)
 
 Once the editor loads, you will be greeted by 1️⃣ a preview of the project's README.txt. 2️⃣ Click on the `docs` directory in the menu on the left, this will expand the directory. To confirm that you are working in the right branch 3️⃣️ it will say `main` in the bottom left of the editor.
-![Web Editor 2](img/dev-docs-web-editor-2.png)
+![Web Editor 2](img/web-editor-2.png)
 
 Once you have expanded the `docs` directory, 1️⃣ click on the `src` directory. All sub-directories within the `src` directory contain the files that become the documentation. Each sub-directory contains an `index.md` file that is required for the building of the documentation and static site. If you add a new sub-directory into any folder it must also contain a populated `index.md` file.
-![Web Editor 3](img/dev-docs-web-editor-3.png){: style="height:300px"}
+![Web Editor 3](img/web-editor-3.png){: style="height:300px"}
 
 Once you have chosen which section of documentation you would like to edit (e.g. user/guide/index.md), click on the file and it will open in the web editor.
-![Web Editor 4](img/dev-docs-web-editor-4.png)
+![Web Editor 4](img/web-editor-4.png)
 
 Once you have the file open, you can start adding to the documentation using [Markdown](https://www.markdownguide.org/) syntax. If you need to add images to your documentation, add them to the relative `img` sub-directories following the naming conventions set out in the `naming-convention.README` within the `img` folders.
-![Web Editor 5](img/dev-docs-web-editor-5.png)
+![Web Editor 5](img/web-editor-5.png)
 
 When you have completed making additions to (or editing) the documentation, 1️⃣ click on the source control tab then 2️⃣ click on the `plus` symbol next to the changes you are finished with to stage them, 3️⃣️ add a commit message that is associated with the work you have done, and the 4️⃣ Click on `Commit & Push`
-![Web Editor 6](img/dev-docs-web-editor-6.png)
+![Web Editor 6](img/web-editor-6.png)
 
 Once you have committed your changes, 1️⃣ Click on the burger menu and then 2️⃣ click on `Go To Repository`
-![Web Editor 7](img/dev-docs-web-editor-7.png)
+![Web Editor 7](img/web-editor-7.png)
 
 Your fork of the repository will be opened in a new tab within your browser, navigate to that tab. Once there 1️⃣ ensure you are on the `main`, you should see how many commits ahead of the upstream branch you are, then 2️⃣ click on `Contribute`-> `Open pull request`.
-![Pull Request 1](img/dev-docs-pull-request-1.png)
+![Pull Request 1](img/pull-request-1.png)
 
 On the next screen, 1️⃣ give your pull request a meaningful title, 2️⃣ give additional details regarding changes made in the larger text box, then 3️⃣️ click on `Create pull request`. Also ensure you are creating a pull request to the upstream `main` branch from your `main` branch.
-![Pull Request 2](img/dev-docs-pull-request-2.png)
+![Pull Request 2](img/pull-request-2.png)
 
 Once your pull request is opened you need to wait for it to be merged before you can open a new one.
 

src/developer/guide/workflows/github.md

@@ -32,9 +32,9 @@ license: This program is free software; you can redistribute it and/or modify it
 
 ### Committing To Project
 
-Follow our [commit message conventions](./templates/commit-message-convention.md).
+Follow our [commit message conventions](../templates/commit-message-convention.md).
 
 ### Pull Request Template
 
 If it has related issues, add links to the issues(like `#123`) in the description.
-Fill in the [Pull Request Template](./templates/pull-request-template.md) by check your case.
+Fill in the [Pull Request Template](../templates/pull-request-template.md) by check your case.

src/developer/index.md

@@ -18,7 +18,7 @@ This is the homepage for all developer related documentation.
 
 * The [developer guide](guide/index.md), which describes common workflows for developers in a tutorial format. This includes instructions on how to set up your developer environment, check out the code, run it locally etc.
 * The [developer manual](manual/index.md), which describes each python module and its classes, functions etc. This section is autogenerated.
-* The [Workflows:](./workflows/index.md), Examples of typical workflows for adding features, fixing bugs etc.
+* The [Workflows:](guide/workflows/index.md), Examples of typical workflows for adding features, fixing bugs etc.
 * The [api guide](api/guide/index.md), which describes common workflows for using the restful API.
 * The [api manual](api/manual/index.md), which describes each API endpoint and its parameters, return values etc. This section is autogenerated.
 

src/user/guide/API_Documentation.md

@@ -3,35 +3,35 @@
 ## Data-Pipelines
 
 **Running on Databricks**
+
 | **Source** | **Platform** | **Type** |**Description** |**Status** |
-| :--------- | :----------- | :-------------- |:-------------- |:--------- |
+| :--------- | :----------- | :-------------- | :-------------- | :--------- |
 | ACLED | ArcGIS | Point Layer | Conflict Events | ✅ every Friday |
 | ACLED | GeoSight | Indicator | Number of Conflicts in the last 30 days |✅ every Friday |
 | ACLED | GeoSight | Indicator | Number of Fatalities in the last 30 days |✅ every Friday |
 | ACLED | GeoSight | Indicator | % Change of Fatalities in the last 7 days |✅ every Friday |
 | ACLED | GeoSight | Related Table | Conflict Events |🔜 coming soon |
 
-
 The following documentation explains the ETL-scripts for pulling data into a Pandas DataFrame, geocoding the data using **GeoRepo**, and calculating indicators that can be pushed to **GeoSight**, as well as pushing the data points to an **ArcGIS** layer.
 
 **The different stages and tasks are divided into separate functions to facilitate easier updating and modification.**
 
 The directory `ACLED` contains all scripts specifically made for this source of data, along with **further explanation for using the ACLED API and calculating basic conflict indicators**. The general flow of data is as follows:
 
-|-- `ACLED Data - Pull ACLED data into pandas DataFrame`\
-|  Pulls data from the source and structures it into a Pandas DataFrame.\
-|\
-|-- `GeoRepo - Geocoding pandas DataFrames`\
-|  Retrieves the 'ucodes' from GeoRepo for the specified administrative level.\
-  |\
-  |-- `GeoSight - API functions`\
-  |  |-- `GeoSight - ACLED Conflict Indicators`\
-  |  |  Calculates indicators and pushes them to GeoSight.\
-  |  |\
-  |  |-- `GeoSight - ACLED Related Tables`\
-  |  |  *COMING SOON*\
-  |\
-  |-- `ArcGIS - ACLED data pipeline`\
+|-- `ACLED Data - Pull ACLED data into pandas DataFrame`<br/>
+|&emsp;&emsp;Pulls data from the source and structures it into a Pandas DataFrame.<br/>
+|<br/>
+|-- `GeoRepo - Geocoding pandas DataFrames`<br/>
+|&emsp;&emsp;Retrieves the 'ucodes' from GeoRepo for the specified administrative level.<br/>
+&emsp;&emsp;|<br/>
+&emsp;&emsp;|-- `GeoSight - API functions`<br/>
+&emsp;&emsp;|&emsp;&emsp;|-- `GeoSight - ACLED Conflict Indicators`<br/>
+&emsp;&emsp;|&emsp;&emsp;|&emsp;&ensp;Calculates indicators and pushes them to GeoSight.<br/>
+&emsp;&emsp;|&emsp;&emsp;|<br/>
+&emsp;&emsp;|&emsp;&emsp;|-- `GeoSight - ACLED Related Tables`<br/>
+&emsp;&emsp;|&emsp;&emsp;|&emsp;&ensp;*COMING SOON*<br/>
+&emsp;&emsp;|<br/>
+&emsp;&emsp;|-- `ArcGIS - ACLED data pipeline`<br/>
 &emsp;&emsp;|&emsp;&emsp;Updates ArcGIS layer.