Skip to content

Commit

Permalink
touch up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bckohan committed Jun 7, 2024
1 parent 18c5051 commit ca2dd62
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 11 deletions.
13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,7 @@ static analysis tools should not produce any errors or warnings. Disabling certa
warnings where justified is acceptable:

```shell
poetry run isort render_static
poetry run black render_static
poetry run mypy render_static
poetry run pylint render_static
poetry check
poetry run pip check
./check.sh
poetry run python -m readme_renderer ./README.md
```

Expand All @@ -59,7 +54,7 @@ poetry run python -m readme_renderer ./README.md
`django-render-static` is setup to use
[django-pytest](https://pytest-django.readthedocs.io/en/latest/) to allow
[pytest](https://docs.pytest.org/en/stable/) to run Django unit tests. All the tests are housed in
render_static/tests/tests.py. Before a PR is accepted, all tests must be passing and the code
tests/tests.py. Before a PR is accepted, all tests must be passing and the code
coverage must be at 100%.

To run the full suite:
Expand All @@ -78,6 +73,6 @@ For instance to run all tests in DefinesToJavascriptTest, and then just the test
you would do:

```shell
poetry run pytest render_static/tests/tests.py::DefinesToJavascriptTest
poetry run pytest render_static/tests/tests.py::DefinesToJavascriptTest::test_classes_to_js
poetry run pytest tests/tests.py::DefinesToJavascriptTest
poetry run pytest tests/tests.py::DefinesToJavascriptTest::test_classes_to_js
```
5 changes: 4 additions & 1 deletion doc/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ Change Log
v3.0.0
======

**This is a major version upgrade - please see migration guide for instructions
on how to** :ref:`migrate from version 2.x to 3.x. <migration_2_3>`

* Implemented `Move tests into top level directory. <https://github.com/bckohan/django-render-static/issues/149>`_
* Implemented `Remove wrapped dependency required mishegoss and replace with jinja2 module level imports <https://github.com/bckohan/django-render-static/issues/148>`_
* Implemented `Allow context import path to also point to a module. <https://github.com/bckohan/django-render-static/issues/147>`_
Expand Down Expand Up @@ -72,7 +75,7 @@ v2.0.0
======

**This is a major version upgrade - please see migration guide for instructions
on how to** :doc:`migration` **from version 1.x to 2.x.**
on how to** :ref:`migrate from version 1.x to 2.x. <migration_1_2>`

* Implemented `Add some default templates to ship for defines, urls and enums. <https://github.com/bckohan/django-render-static/issues/116>`_
* Implemented `Generate JDoc comments in the generated URLResolver class. <https://github.com/bckohan/django-render-static/issues/115>`_
Expand Down
1 change: 1 addition & 0 deletions doc/source/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Usage
.. typer:: render_static.management.commands.renderstatic.Command:typer_app
:prog: manage.py renderstatic
:width: 90
:theme: dark

Example
~~~~~~~
Expand Down
16 changes: 16 additions & 0 deletions doc/source/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@ Migration
page documents how to migrate past the breaking changes introduced by major
version updates.

.. _migration_2_3:

2.x -> 3.x
----------

There are some import path changes in 3.0:

* ``render_static.ClassURLWriter`` -> ``render_static.transpilers.ClassURLWriter``
* ``render_static.SimpleURLWriter`` -> ``render_static.transpilers.SimpleURLWriter``
* ``render_static.EnumClassWriter`` -> ``render_static.transpilers.EnumClassWriter``
* ``render_static.DefaultDefineTranspiler`` -> ``render_static.transpilers.DefaultDefineTranspiler``
* ``render_static.backends.StaticJinja2Templates`` ->
``render_static.backends.jinja2.StaticJinja2Templates``

.. _migration_1_2:

1.x -> 2.x
----------

Expand Down
2 changes: 1 addition & 1 deletion doc/source/templatetags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ specific url names. For instance:

.. code-block:: js+django

{% urls_to_js transpiler='render_static.SimpleURLWriter' %}
{% urls_to_js transpiler='render_static.transpilers.SimpleURLWriter' %}

{% override 'namespace:path_name' %}
return "/an/overridden/path";
Expand Down

0 comments on commit ca2dd62

Please sign in to comment.