Update documentation

Author: github-actions[bot]

docs/.nojekyll

@@ -0,0 +1,109 @@
+********************************
+Contributiong to yfinance
+********************************
+
+`yfinance` relies on the community to investigate bugs and contribute code. Here’s how you can help:
+
+Contributing
+------------
+
+1. Fork the repository on GitHub.
+2. Clone your forked repository:
+
+   .. code-block:: bash
+
+      git clone https://github.com/your-username/yfinance.git
+
+3. Create a new branch for your feature or bug fix:
+
+   .. code-block:: bash
+
+      git checkout -b feature-branch-name
+
+4. Make your changes, commit them, and push your branch to GitHub. To keep the commit history and `network graph <https://github.com/ranaroussi/yfinance/network>`_ compact:
+
+   Use short summaries for commits
+
+   .. code-block:: shell
+
+      git commit -m "short summary" -m "full commit message"
+
+   **Squash** tiny or negligible commits with meaningful ones.
+
+   .. code-block:: shell
+
+      git rebase -i HEAD~2
+      git push --force-with-lease origin <branch-name>
+
+5. Open a pull request on the `yfinance` GitHub page.
+
+For more information, see the `Developer Guide <https://github.com/ranaroussi/yfinance/discussions/1084>`_.
+
+Branches
+---------
+
+To support rapid development without breaking stable versions, this project uses a two-layer branch model:
+
+.. image:: assets/branches.png
+   :alt: Branching Model
+
+`Inspiration <https://miro.medium.com/max/700/1*2YagIpX6LuauC3ASpwHekg.png>`_
+
+- **dev**: New features and some bug fixes are merged here. This branch allows collective testing, conflict resolution, and further stabilization before merging into the stable branch.
+- **main**: Stable branch where PIP releases are created.
+
+By default, branches target **main**, but most contributions should target **dev**. 
+
+**Exceptions**:
+Direct merges to **main** are allowed if:
+
+- `yfinance` is massively broken
+- Part of `yfinance` is broken, and the fix is simple and isolated
+
+Unit Tests
+----------
+
+Tests are written using Python’s `unittest` module. Here are some ways to run tests:
+
+- **Run all price tests**:
+
+  .. code-block:: shell
+
+     python -m unittest tests.test_prices
+
+- **Run a subset of price tests**:
+
+  .. code-block:: shell
+
+     python -m unittest tests.test_prices.TestPriceRepair
+
+- **Run a specific test**:
+
+  .. code-block:: shell
+
+     python -m unittest tests.test_prices.TestPriceRepair.test_ticker_missing
+
+- **Run all tests**:
+
+  .. code-block:: shell
+
+     python -m unittest discover -s tests
+
+Rebasing
+--------------
+
+If asked to move your branch from **main** to **dev**:
+
+1. Ensure all relevant branches are pulled.
+2. Run:
+
+   .. code-block:: shell
+
+      git checkout <your-branch>
+      git rebase --onto dev main <branch-name>
+      git push --force-with-lease origin <branch-name>
+
+Running the GitHub Version of yfinance
+--------------------------------------
+
+To download and run a GitHub version of `yfinance`, refer to `GitHub discussion <https://github.com/ranaroussi/yfinance/discussions/1080>`_

docs/Ticker.md

@@ -0,0 +1,46 @@
+*************************************
+Contribution to the documentation
+*************************************
+
+.. contents:: Documentation:
+   :local:
+
+About documentation
+------------------------
+* yfinance documentation is written in reStructuredText (rst) and built using Sphinx.
+* The documentation file is in `doc/source/..`.
+* Most of the notes under API References read from class and methods docstrings. These documentations, found in `doc/source/reference/api` is autogenerated by Sphinx and not included in git.
+
+Building documentation locally
+-------------------------------
+To build the documentation locally, follow these steps:
+
+1. **Install Required Dependencies**:
+
+   * Make sure `Sphinx` and any other dependencies are installed. If a `requirements.txt` file is available, you can install dependencies by running:
+   
+   .. code-block:: console
+
+      pip install -r requirements.txt
+   
+
+2. **Build with Sphinx**:
+    
+   * After dependencies are installed, use the sphinx-build command to generate HTML documentation. 
+   * Go to `doc/` directory Run:
+
+   .. code-block:: console
+
+      make clean && make html 
+
+3. **View Documentation Locally**:
+
+   * Open `doc/build/html/index.html` in the browser to view the generated documentation.
+
+Building documentation on main 
+-------------------------------
+The documentation updates are built on merge to `main` branch. This is done via GitHub Actions workflow based on `/yfinance/.github/workflows/deploy_doc.yml`.
+
+1. Reivew the changes locally and push to `dev`.
+
+2. When `dev` gets merged to `main`, GitHub Actions workflow is automated to build documentation.

docs/TickerBase.md

@@ -0,0 +1,9 @@
+Development
+===============================
+
+.. toctree::
+   :maxdepth: 1
+
+   contributing
+   documentation
+   reporting_bug

docs/Tickers.md

@@ -0,0 +1,5 @@
+********************************
+Reporting a Bug
+********************************
+
+Open a new issue on our `GitHub <https://github.com/ranaroussi/yfinance/issues>`_.

docs/_images/branches.png

@@ -0,0 +1,9 @@
+Getting Started
+===============
+
+.. toctree::
+   :maxdepth: 1
+
+   installation
+   quick_start
+   legal