-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into feat/python3.10-support
- Loading branch information
Showing
21 changed files
with
278 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
name: "\U0001F4D8 Documentation report" | ||
about: 'Something isn''t described correctly in the documentation or needs to be updated? | ||
Here is the right place to report. ' | ||
title: "[DOC]" | ||
labels: 'component: documentation' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- | ||
Please fill in each section below, otherwise, your issue will be closed. | ||
This info allows django CMS maintainers to diagnose (and fix!) your issue | ||
as quickly as possible. | ||
--> | ||
|
||
## Description | ||
|
||
<!-- | ||
If this is a security issue stop immediately and follow the instructions at: | ||
http://docs.django-cms.org/en/latest/contributing/development-policies.html#reporting-security-issues | ||
--> | ||
|
||
## Screenshots | ||
|
||
<!--If applicable, add screenshots to help explain your problem. | ||
--> | ||
|
||
## Additional information (CMS/Python/Django versions) | ||
|
||
<!-- | ||
Add any other context about the problem such as environment, | ||
CMS/Python/Django versions, logs etc. here. | ||
--> | ||
|
||
## Do you want to help fix this documentation issue? | ||
|
||
<!-- | ||
The django CMS project is managed and kept alive by its open source community and is backed by the [django CMS Association](https://www.django-cms.org/en/about-us/). We therefore welcome any help and are grateful if people contribute to the project. Please use 'x' to check the items below. | ||
--> | ||
|
||
* [ ] Yes, I want to help fix this issue and I will join #workgroup-documentation on [Slack](https://www.django-cms.org/slack) to confirm with the team that a PR is welcome. | ||
* [ ] No, I only want to report the issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
========================= | ||
django CMS Documentation | ||
========================= | ||
|
||
Run the documentation locally | ||
----------------------------- | ||
|
||
Install the Enchant libary | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You will need to install the | ||
`enchant <https://www.abisource.com/projects/enchant/>`__ library that | ||
is used by ``pyenchant`` for spelling. | ||
|
||
macOS: | ||
^^^^^^ | ||
|
||
.. code:: bash | ||
brew install enchant | ||
After that: | ||
|
||
Fork & Clone the repository: | ||
^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code:: bash | ||
git@github.com:your-github-username/django-cms.git | ||
Switch to the django-cms directory: | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code:: bash | ||
cd django-cms/docs | ||
Install the dependencies: | ||
^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code:: bash | ||
make install | ||
This command creates a virtual environment and installs the required | ||
dependencies there. | ||
|
||
Start the development server: | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code:: bash | ||
make run | ||
Open the local docs instance in your browser: | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code:: bash | ||
open http://0.0.0.0:8001/ | ||
The documentation uses livereload. This means, that every time something | ||
is changed, the documentation will automatically reload in your | ||
browser. | ||
|
||
Contribute | ||
---------- | ||
|
||
If you find anything that could be improved or changed in your opinion, | ||
feel free to create a pull request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.