Fixed documentation inside the template

[santacodes]

As brought up in this discussion the documentation should build now without any errors.

[Saransh-cpp]

This looks good to me, but I'll let @agriyakhetarpal (pybamm's goto documentation person, haha) do the final review

[brosaplanella]

Looks good, just see a few comments

[arjxn-py]

Thanks @santacodes, some comments below

[arjxn-py]

Looks good

[santacodes]

@agriyakhetarpal do you have any ideas on what we could replace the pybamm.css file with in the _static folder? I think it would be good to merge after that. Refer here.

[agriyakhetarpal]

Thanks, @santacodes! I think it is better to remove the CSS file altogether and keep html_css_files = ["custom.css"] commented out in conf.py since the PyData Sphinx Theme already provides its own styles. The CSS file contains a lot of PyBaMM-specific configuration that users can copy manually if they wish to adjust and tinker with things. This is the only change I would request – the rest of the code looks good to me, and I'm glad to approve this PR after that.

[santacodes]

Thanks, @santacodes! I think it is better to remove the CSS file altogether and keep html_css_files = ["custom.css"] commented out in conf.py since the PyData Sphinx Theme already provides its own styles. The CSS file contains a lot of PyBaMM-specific configuration that users can copy manually if they wish to adjust and tinker with things. This is the only change I would request – the rest of the code looks good to me, and I'm glad to approve this PR after that.

The doctests would fail without something inside the _static folder, as we cannot copy an empty directory while generating a project with copier. Is there something else we could add in the _static folder just as a dummy to keep the tests running or is there a way to suppress the warning for that?

In reference to this

[agriyakhetarpal]

Oh, I see. In that case, we can add an empty .gitkeep file inside the _static folder, which is likely what you need.

[agriyakhetarpal]

Thanks for the fixes, @santacodes!