deploy: 2a85543

assets/_mkdocstrings.css

@@ -26,39 +26,94 @@
   float: right;
 }
 
-/* Keep headings consistent. */
-h1.doc-heading,
-h2.doc-heading,
-h3.doc-heading,
-h4.doc-heading,
-h5.doc-heading,
-h6.doc-heading {
-  font-weight: 400;
-  line-height: 1.5;
-  color: inherit;
-  text-transform: none;
+/* Backward-compatibility: docstring section titles in bold. */
+.doc-section-title {
+  font-weight: bold;
+}
+
+/* Symbols in Navigation and ToC. */
+:root,
+[data-md-color-scheme="default"] {
+  --doc-symbol-attribute-fg-color: #953800;
+  --doc-symbol-function-fg-color: #8250df;
+  --doc-symbol-method-fg-color: #8250df;
+  --doc-symbol-class-fg-color: #0550ae;
+  --doc-symbol-module-fg-color: #5cad0f;
+
+  --doc-symbol-attribute-bg-color: #9538001a;
+  --doc-symbol-function-bg-color: #8250df1a;
+  --doc-symbol-method-bg-color: #8250df1a;
+  --doc-symbol-class-bg-color: #0550ae1a;
+  --doc-symbol-module-bg-color: #5cad0f1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --doc-symbol-attribute-fg-color: #ffa657;
+  --doc-symbol-function-fg-color: #d2a8ff;
+  --doc-symbol-method-fg-color: #d2a8ff;
+  --doc-symbol-class-fg-color: #79c0ff;
+  --doc-symbol-module-fg-color: #baff79;
+
+  --doc-symbol-attribute-bg-color: #ffa6571a;
+  --doc-symbol-function-bg-color: #d2a8ff1a;
+  --doc-symbol-method-bg-color: #d2a8ff1a;
+  --doc-symbol-class-bg-color: #79c0ff1a;
+  --doc-symbol-module-bg-color: #baff791a;
+}
+
+code.doc-symbol {
+  border-radius: .1rem;
+  font-size: .85em;
+  padding: 0 .3em;
+  font-weight: bold;
+}
+
+code.doc-symbol-attribute {
+  color: var(--doc-symbol-attribute-fg-color);
+  background-color: var(--doc-symbol-attribute-bg-color);
 }
 
-h1.doc-heading {
-  font-size: 1.6rem;
+code.doc-symbol-attribute::after {
+  content: "attr";
 }
 
-h2.doc-heading {
-  font-size: 1.2rem;
+code.doc-symbol-function {
+  color: var(--doc-symbol-function-fg-color);
+  background-color: var(--doc-symbol-function-bg-color);
 }
 
-h3.doc-heading {
-  font-size: 1.15rem;
+code.doc-symbol-function::after {
+  content: "func";
 }
 
-h4.doc-heading {
-  font-size: 1.10rem;
+code.doc-symbol-method {
+  color: var(--doc-symbol-method-fg-color);
+  background-color: var(--doc-symbol-method-bg-color);
 }
 
-h5.doc-heading {
-  font-size: 1.05rem;
+code.doc-symbol-method::after {
+  content: "meth";
 }
 
-h6.doc-heading {
-  font-size: 1rem;
-}
+code.doc-symbol-class {
+  color: var(--doc-symbol-class-fg-color);
+  background-color: var(--doc-symbol-class-bg-color);
+}
+
+code.doc-symbol-class::after {
+  content: "class";
+}
+
+code.doc-symbol-module {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
+}
+
+code.doc-symbol-module::after {
+  content: "mod";
+}
+
+.doc-signature .autorefs {
+  color: inherit;
+  border-bottom: 1px dotted currentcolor;
+}

changelog/changelog.md

@@ -1,6 +1,13 @@
 # Release Notes
 ---
 
+## [0.4.1](https://github.com/osl-incubator/envers/compare/0.4.0...0.4.1) (2024-09-28)
+
+
+### Bug Fixes
+
+* Update project structure and configuration ([#20](https://github.com/osl-incubator/envers/issues/20)) ([2a85543](https://github.com/osl-incubator/envers/commit/2a85543f09923d273bde7627a208e87d25c326e3))
+
 # [0.4.0](https://github.com/osl-incubator/envers/compare/0.3.0...0.4.0) (2023-12-23)
 
 

contributing/contributing.md

@@ -1,9 +1,8 @@
 # Contributing
 
-In order to be able to contribute, it is important that you understand
-the project layout.
-This project uses the *src layout*, which means that the package code is located
-at `./src/envers`.
+In order to be able to contribute, it is important that you understand the
+project layout. This project uses the _src layout_, which means that the package
+code is located at `./src/envers`.
 
 For my information, check the official documentation:
 https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/
@@ -29,27 +28,25 @@ Report bugs at https://github.com/osl-incubator/envers/issues.
 
 If you are reporting a bug, please include:
 
-  - Your operating system name and version.
-  - Any details about your local setup that might be helpful in
-    troubleshooting.
-  - Detailed steps to reproduce the bug.
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
 
 ### Fix Bugs
 
-Look through the GitHub issues for bugs. Anything tagged with “bug” and
-“help wanted” is open to whoever wants to implement it.
+Look through the GitHub issues for bugs. Anything tagged with “bug” and “help
+wanted” is open to whoever wants to implement it.
 
 ### Implement Features
 
-Look through the GitHub issues for features. Anything tagged with
-“enhancement” and “help wanted” is open to whoever wants to implement
-it.
+Look through the GitHub issues for features. Anything tagged with “enhancement”
+and “help wanted” is open to whoever wants to implement it.
 
 ### Write Documentation
 
-Envers could always use more documentation,
-whether as part of the official Envers docs,
-in docstrings, or even on the web in blog posts, articles, and such.
+Envers could always use more documentation, whether as part of the official
+Envers docs, in docstrings, or even on the web in blog posts, articles, and
+such.
 
 ### Submit Feedback
 
@@ -58,11 +55,10 @@ https://github.com/osl-incubator/envers/issues.
 
 If you are proposing a feature:
 
-  - Explain in detail how it would work.
-  - Keep the scope as narrow as possible, to make it easier to
-    implement.
-  - Remember that this is a volunteer-driven project, and that
-    contributions are welcome :)
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions are
+  welcome :)
 
 ## Get Started!
 
@@ -75,31 +71,28 @@ Ready to contribute? Here’s how to set up `envers` for local development.
     $ git clone [email protected]:your_name_here/envers.git
 
 3.  Install your local copy into a virtualenv. Assuming you have
-    virtualenvwrapper installed, this is how you set up your fork for
-    local development::
+    virtualenvwrapper installed, this is how you set up your fork for local
+    development::
 
-    $ mkvirtualenv envers
-    $ cd envers/
-    $ python setup.py develop
+    $ mkvirtualenv envers $ cd envers/ $ python setup.py develop
 
 4.  Create a branch for local development::
 
     $ git checkout -b name-of-your-bugfix-or-feature
 
     Now you can make your changes locally.
 
-5.  When you’re done making changes, check that your changes pass flake8
-    and the tests, including testing other Python versions with tox::
+5.  When you’re done making changes, check that your changes pass flake8 and the
+    tests, including testing other Python versions with tox::
 
-    $ make lint
-    $ make test
+    $ make lint $ make test
 
     To get flake8 and tox, just pip install them into your virtualenv.
 
 6.  Commit your changes and push your branch to GitHub::
 
-    $ git add . $ git commit -m “Your detailed description of your
-    changes.” $ git push origin name-of-your-bugfix-or-feature
+    $ git add . $ git commit -m “Your detailed description of your changes.” $
+    git push origin name-of-your-bugfix-or-feature
 
 7.  Submit a pull request through the GitHub website.
 
@@ -108,50 +101,50 @@ Ready to contribute? Here’s how to set up `envers` for local development.
 Before you submit a pull request, check that it meets these guidelines:
 
 1.  The pull request should include tests.
-2.  If the pull request adds functionality, the docs should be updated.
-    Put your new functionality into a function with a docstring, and add
-    the feature to the list in README.rst.
+2.  If the pull request adds functionality, the docs should be updated. Put your
+    new functionality into a function with a docstring, and add the feature to
+    the list in README.rst.
 3.  The pull request should work for Python >= 3.8.
 
 ## Tips
 
 To run a subset of tests::
+
 ```
 $ pytest tests.test_envers
 ```
 
-
 ## Release
 
-This project uses semantic-release in order to cut a new release
-based on the commit-message.
+This project uses semantic-release in order to cut a new release based on the
+commit-message.
 
 ### Commit message format
 
-**semantic-release** uses the commit messages to determine the consumer
-impact of changes in the codebase. Following formalized conventions for
-commit messages, **semantic-release** automatically determines the next
+**semantic-release** uses the commit messages to determine the consumer impact
+of changes in the codebase. Following formalized conventions for commit
+messages, **semantic-release** automatically determines the next
 [semantic version](https://semver.org) number, generates a changelog and
 publishes the release.
 
-By default, **semantic-release** uses [Angular Commit Message
-Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format).
-The commit message format can be changed with the `preset` or `config`
-options_ of the
+By default, **semantic-release** uses
+[Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format).
+The commit message format can be changed with the `preset` or `config` options\_
+of the
 [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options)
 and
 [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options)
 plugins.
 
 Tools such as [commitizen](https://github.com/commitizen/cz-cli) or
-[commitlint](https://github.com/conventional-changelog/commitlint) can
-be used to help contributors and enforce valid commit messages.
+[commitlint](https://github.com/conventional-changelog/commitlint) can be used
+to help contributors and enforce valid commit messages.
 
-The table below shows which commit message gets you which release type
-when `semantic-release` runs (using the default configuration):
+The table below shows which commit message gets you which release type when
+`semantic-release` runs (using the default configuration):
 
 | Commit message                                                 | Release type     |
-|----------------------------------------------------------------|------------------|
+| -------------------------------------------------------------- | ---------------- |
 | `fix(pencil): stop graphite breaking when pressure is applied` | Fix Release      |
 | `feat(pencil): add 'graphiteWidth' option`                     | Feature Release  |
 | `perf(pencil): remove graphiteWidth option`                    | Chore            |
@@ -160,5 +153,5 @@ when `semantic-release` runs (using the default configuration):
 source:
 <https://github.com/semantic-release/semantic-release/blob/master/README.md#commit-message-format>
 
-As this project uses the `squash and merge` strategy, ensure to apply
-the commit message format to the PR's title.
+As this project uses the `squash and merge` strategy, ensure to apply the commit
+message format to the PR's title.