search

engineerjoe440 / ElectricPy

Electrical Engineering Formulas in Python
https://electricpy.readthedocs.io/en/latest/
MIT License
86 stars 16 forks source link

`ElectricPy` website bug #94

Closed Lakshmikanth2001 closed 2 years ago

Lakshmikanth2001 commented 2 years ago

Describe the bug A clear and concise description of what the bug is.

Reproduction Code docsource/index.rst

# Setup
-------------------------
Contents:
-------------------------

.. toctree::
   :maxdepth: 1

   electricpyapi
   constants
   additionalresources
   changes
   Github <https://github.com/engineerjoe440/ElectricPy>
   PyPI <https://pypi.org/project/electricpy>

# Code which causes failure
   Github <https://github.com/engineerjoe440/ElectricPy>
   PyPI <https://pypi.org/project/electricpy>

Expected behavior

proper logo rendering

image

Screenshots

Acutal web site

image

Additional context ElectricPy { URL from google top search )

Our documentation html page is not rendered properly try to correct docsource/index.rst

engineerjoe440 commented 2 years ago

Looks like this might be something related to the transition to use ReadTheDocs: https://electricpy.readthedocs.io/en/latest/

That said, there's still some issues there: image

engineerjoe440 commented 2 years ago

OK! I think I've corrected this with the use of the MyST-Parser package (rather than m2r2, which seems to have been the culprit). I'll note that the change is only relevant on the GH-pages site, and the develop branch of the ReadTheDocs site as of this moment in time. It'll update the latest branch when we cut a new release of ElectricPy (which I'll need to start thinking about, here, pretty soon).

image

image