Fix docs

[TomTranter]

No description provided.

[TomTranter]

@Saransh-cpp after some playing I switched to using conda to build the packages instead of pip. I added some specific mkdocs dependencies to the environment.yml though. Is there a way to only install these with a [docs] type argument?

[codecov]

Codecov Report

Merging #163 (5846890) into main (24bc5a9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #163   +/-   ##
=======================================
  Coverage   96.85%   96.85%           
=======================================
  Files          11       11           
  Lines        1272     1272           
=======================================
  Hits         1232     1232           
  Misses         40       40           

[Saransh-cpp]

AFAIK conda doesn't support adding tags or arguments for dependencies. This answer suggests adding a new environment.yml file (maybe named environment.docs.yml) with only the docs requirements and using both of them to setup an environment for docs.

[TomTranter]

@Saransh-cpp this would be a good solution if I could figure out how to run any bespoke conda commands automatically using read the docs it seems all it lets you do is define a single environment.yml to run. There are bepoke build commands for when you are not using conda. I hesitate to add the dependencies to the package just for building the docs but seems like the simplest solution. Maybe @wigging has some thoughts?

[TomTranter]

The other equally unappealing option would be to just have a separate yml for docs with all the packages duplicated and the extra ones included.

[TomTranter]

I have submitted a question on read the docs about running bespoke conda commands