Skip to content

Commit

Permalink
Merge pull request #458 from Anu-Ra-g/doc_update
Browse files Browse the repository at this point in the history
made documentation updates
  • Loading branch information
martindurant authored Jun 4, 2024
2 parents 801270f + cc0c1a4 commit 2739159
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ First we'll create and activate the build environment:
Now that you have the correct dependencies installed in your environment,
you should be able to install your development version of kerchunk locally.
In the projects home directory run:
In the project's home directory run:

.. code-block:: sh
Expand Down Expand Up @@ -151,7 +151,7 @@ The above can be simplified to
git checkout -b shiny-new-feature
This changes your working directory to the shiny-new-feature branch. Keep any
This changes your working directory to the ``shiny-new-feature`` branch. Keep any
changes in this branch specific to one bug or feature so it is clear
what the branch brings to *kerchunk*. You can have many "shiny-new-features"
and switch in between them using the ``git checkout`` command.
Expand Down Expand Up @@ -187,7 +187,7 @@ Contributing documentation

Documentation improvements are appreciated. The documentation is contained within the ``docs`` directory of the project.
It is written in ``ReStructured Text (.rst)``, which is similar to markdown, but features more functionality.
These ReStructured text files are built into ``html`` using the python `sphinx (https://www.sphinx-doc.org/en/master/)_` package.
These ReStructured text files are built into ``html`` using the python `sphinx <https://www.sphinx-doc.org/en/master/>`_ package.

You can create a virtual environment by running:

Expand Down

0 comments on commit 2739159

Please sign in to comment.