Sphinx build from Action 2d42c8b

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b6bbbc563942bcc1631f7760fcf09386
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/configuration/calendar.rst.txt

@@ -0,0 +1,17 @@
+#####################
+Calendar Mode Options
+#####################
+
+========================= ========== ============================================================================================================
+ Name                      Type       Description
+========================= ========== ============================================================================================================
+ enableModeChange          boolean    ``false`` Set true to enable mode change (Calendar/Events) must have "name" set to toggle
+ firstDayOfWeek            integer    ``1`` First day of week, default 1 for Monday
+ showLastCalendarWeek      boolean    ``false`` If true it will always show 6 lines. If false, the 6th line won't be displayed if not needed.
+ calEventTime              boolean    ``false`` If true the time will be shown on the event summary for the selected day
+ disableCalEventLink       boolean    ``false`` If true the link will be disabled on the event summary for the selected day
+ disableCalLocationLink    boolean    ``false`` If true the link will be disabled on the event location icon for the selected day
+ calShowDescription        boolean    ``false`` If true this will display the description in calendar mode
+ disableCalLink            boolean    ``false`` If true the link to google calendar will be removed
+ cardHeight                string     ``100%`` Change to ``px`` or ``%`` to set the height of the card, this will add scroll if it is too small
+========================= ========== ============================================================================================================

_sources/configuration/entity.rst.txt

@@ -0,0 +1,29 @@
+##############
+Entity Options
+##############
+
+==================== ========= =============================================================================================================
+ Name                 Type      Description
+==================== ========= =============================================================================================================
+ icon                 string    ``null`` Add an icon to a calendar. If not set, will use the entity icon set in HA. see note below
+ startTimeFilter      string    Only shows events between specific times _NOTE_ must be set with ``endTimeFilter`` format: ``'10:00'``
+ endTimeFilter        string    Only shows events between specific times _NOTE_ must be set with ``startTimeFilter`` format: ``'17:00'``
+ maxDaysToShow        integer   ``7`` Maximum number of days to show. Overrides main configuration maxDaysToShow for this calendar
+ blocklist            string    ``null`` Simple case insensitive regex to ignore events that match title
+ blocklistLocation    string    ``null`` Simple case insensitive regex to ignore events that match location
+ allowlist            string    ``null`` Simple case insensitive regex to only add events that match title
+ allowlistLocation    string    ``null`` Simple case insensitive regex to only add events that match location
+ showMultiDay         boolean   ``false`` Split multi-day events across all days
+ name                 string    ``null`` Add a calendar name to be shown with event
+ eventTitle           string    Where no event title exists, add this string instead, Will only add to this entity, can also be globally set
+ color                string    ``null`` Default color for this calendar's event titles
+==================== ========= =============================================================================================================
+
+.. note::
+   It is not advised to use ``allowlist`` & ``blocklist`` under the same entity.
+
+.. note::
+   Set the calendar entity icon by going to ``Settings -> Entities`` search for ``calendar``
+   Click the calendar you wish to change, click the cog in the top right and set a new icon.
+
+   This is how I recommend setting up the icons now.

_sources/configuration/event.rst.txt

@@ -0,0 +1,24 @@
+##################
+Event Mode Options
+##################
+
+======================= ========== ===========================================================================================================
+ Name                    Type       Description
+======================= ========== ===========================================================================================================
+ showCurrentEventLine    boolean    ``false`` Show line before next event. Don't enable when showProgressBar is true - will look bad
+ showProgressBar         boolean    ``true`` Show event progress with moving icon. Don't enable when showCurrentEventLine - will look bad
+ showFullDayProgress     boolean    ``false`` Enables the progress bar for full day events
+ showRelativeTime        boolean    ``true`` Show relative time until the start of an event
+ showEventIcon           boolean    ``false`` Show the entity icon before the event title
+ softLimit               integer    Adds flexibility when ``maxEventCount`` is set, so if there is only e.g. 1 extra event it would be shown
+ showHiddenText          boolean    ``true`` Show x hidden events when limited number of events selected
+ hiddenEventText         string     ``localize('common.hiddenEventText')`` allows a user to change the text displayed for hidden events
+ showCalendarName        boolean    ``false`` Show the calendar name in Event Mode
+ showWeekNumber          boolean    ``false`` Show the year week number at the beginning of each week
+ showEventDate           boolean    ``true`` Show the event date
+ showDatePerEvent        boolean    ``false`` Show the date next to each event entry
+ showTimeRemaining       boolean    ``false`` Show the amount of time remaining for an event
+ hoursOnSameLine         boolean    ``false`` if set true will move hours to show on the same line as the summary.
+ showAllDayHours         boolean    ``true`` Show "All Day" text under full day events
+ eventDateFormat         string     ``ddd D MMM`` Set the date format for events (`Reference <https://day.js.org/docs/en/display/format>`_)
+======================= ========== ===========================================================================================================

_sources/configuration/language.rst.txt

@@ -0,0 +1,101 @@
+################
+Language Options
+################
+
+.. note:
+   Week / month names are translated automatically
+
+========================== ========= ===============================================================================================================================================================================================================
+ Name                       Type      Description
+========================== ========= ===============================================================================================================================================================================================================
+ untilText                  string    ``Until`` Custom text for ``Until`` text
+ fullDayEventText           string    ``All day`` Custom text for ``All day`` text
+ noEventsForNextDaysText    string    ``No events in the next days`` Custom text for ``No events in the next days`` text
+ noEventText                string    ``No events`` Custom text for ``No events`` text, only if ``showNoEventsForToday`` or ``showNoEventDays`` is true
+ dateFormat                 string    ``LL`` Custom date format - see `list of localized formats <https://day.js.org/docs/en/display/format#localized-formats>`_
+========================== ========= ===============================================================================================================================================================================================================
+
+
+**************
+Locale Support
+**************
+
+I have limited the number of Locales to keep the size down, however if you use
+a specific locale that is not listed, please log an issue and I will look to
+get this added for you.
+
+
+The Configuration editor supports the following locales:
+
+========= ===========
+ Locale    Language
+========= ===========
+ ca        Catalan
+ cs        Czech
+ da        Danish
+ de        German
+ en        English
+ et        Estonian
+ fi        Finnish
+ fr        French
+ hu        Hungarian
+ nb        Norwegian
+ pt        Portuguese
+ ru        Russian
+ sl        Slovenian
+ sv        Swedish
+ uk        Ukranian
+========= ===========
+
+
+
+The card date information supports the following locales:
+
+========= ==============================
+ Locale    Language
+========= ==============================
+ ca        Catalan
+ cs        Czech
+ da        Danish
+ de-at     German (Austria)
+ de-ch     German (Switzerland)
+ de        German
+ en-au     English (Australian)
+ en-ca     English (Canada)
+ en-gb     English (United Kingdom)
+ en-ie     English (Ireland)
+ en-in     English (India)
+ en-nz     English (New Zeland)
+ en-sg     English (Singapore)
+ en-tt     English (Trinidad & Tobago)
+ en        English
+ es-do     Spanish (Dominican Republic)
+ es-pr     Spanish (Puerto Rico)
+ es-us     Spanish (United States)
+ es        Spanish
+ fi        Finnish
+ fr-ca     French (Canada)
+ fr-ch     French (Switzerland)
+ fr        French
+ he        Hebrew
+ hu        Hungarian
+ it-ch     Italian (Switzerland)
+ it        Italian
+ ja        Japanese
+ nb        Norwegian
+ ne        Nepalese
+ nl-be     Dutch (Belgium)
+ nl        Dutch
+ pl        Polish
+ pt-br     Portuguese (Brazil)
+ pt        Portuguese
+ ru        Russian
+ sl        Slovenian
+ sv        Swedish
+ sk        Slovak
+ uk        Ukranian
+========= ==============================
+
+.. note:
+   If you would like a different language to be supported, please log an issue on github
+   stating the language and language code that you would like to be added.

_sources/configuration/main.rst.txt

@@ -0,0 +1,45 @@
+.. _mainoptions:
+
+############
+Main Options
+############
+
+========================= ========= =============== ==========================================================================================================================================================================================================================
+ Name                      Type      Default         Description
+========================= ========= =============== ==========================================================================================================================================================================================================================
+ type                      string    **required**    ``custom:atomic-calendar-revive``
+ entities                  list      **required**    One or more calendars, configured in HA [Google Calendar Component][googlecalcomp]
+ name                      string    optional        Card name.
+ maxDaysToShow             integer   optional        ``7`` Maximum number of days to show; if set to zero will only display currently running events
+ maxEventCount             integer   optional        ``0`` Maximum number of events to show; zero removes any limitation
+ showLocation              boolean   optional        ``true`` Show location link (right side)
+ showMonth                 boolean   optional        ``false`` Show month under day (left side)
+ showLoader                boolean   optional        ``true`` Show animation, when events are being loaded from Google Calendar.
+ showDate                  boolean   optional        ``false`` Show the date on the right side of the card name
+ startDaysAhead            integer   optional        ``0`` If you set more than 0, events will be loaded starting `x` days from today. For example `1` - the component will show events starting from tomorrow, if a negative number is used, events previous will be shown.
+ showDescription           boolean   optional        ``false`` Shows long description of event from Google Calendar.
+ showNoEventsForToday      boolean   optional        ``false`` Shows `No events for today` if no events, instead of omit the entry.
+ sortBy                    boolean   optional        ``start`` Sort events by start time. ``start|milestone|none``
+ disableEventLink          boolean   optional        ``false`` disables links in event title.
+ disableLocationLink       boolean   optional        ``false`` disables links in event location.
+ linkTarget                string    optional        ``_blank`` Allows custom target for links, default will open new tab.
+ defaultMode               integer   optional        ``Event`` Set `Event` to make Events default mode, set `Calendar` to make Calendar mode default
+ refreshInterval           integer   optional        ``60`` Set how often the calendar should refresh data in seconds
+ showHours                 boolean   optional        ``true`` shows when and event starts / ends
+ showRelativeTime          boolean   optional        ``true`` shows amount of time until event starts
+ showPrivate               boolean   optional        ``true`` show private events (only Google Calendar)
+ showNoEventDays           boolean   optional        ``false`` Shows days that have no events, instead of only showing event days
+ descLength                integer   optional        Sets the length of descriptions
+ hideDuplicates            boolean   optional        ``false`` Removes any duplicate items based on summary, start time and end time.
+ showDeclined              boolean   optional        ``false`` show/hide events that have been declined
+ showMultiDay              boolean   optional        ``false`` if set true will show multi-day events on each day
+ showMultiDayEventParts    boolean   optional        ``false`` if set true will show how many days in event and which day it is
+ hideFinishedEvents        boolean   optional        ``false`` if set true will hide any finished events
+ eventTitle                string    optional        Where no event title exists, add this string instead, Will add globally unless entity.eventTitle is set.
+ compactMode               boolean   optional        ``false`` if set true will squash text down to allow for much more compact design
+ language                  string    optional        Not recommended to use, but can set the language code e.g. "gb" / "es"
+ titleLength               integer   optional        Sets the maximum length of the event titles
+ showAllDayEvents          boolean   optional        ``true`` if set false will hide all events that are a full day
+ offsetHeaderDate          boolean   optional        ``false`` if set true the header date will match the startDaysAhead offset date
+ allDayBottom              boolean   optional        ``false`` if set true all day events will show below other running events
+========================= ========= =============== ==========================================================================================================================================================================================================================

_sources/configuration/styling.rst.txt

@@ -0,0 +1,19 @@
+#######
+Styling
+#######
+
+In version 9 of the Atomic Calendar Revive I removed all of the color and
+style Options, this decission was made due to numerous requests for different
+styling to be added and it was becoming unmanageble.
+
+Instead I have now added numerous classes throughout the card, moved to a div
+orientated layout which allows for much more customisation with the use of the
+amazing `card-mod <https://github.com/thomasloven/lovelace-card-mod_>`_
+
+The below video shows you how to find the various classes and add styling with
+card-mod, if there are classes missing that you need, log a feature request
+and I will aim to get that added.
+
+.. image:: https://img.youtube.com/vi/-5MKd7LY-oc/maxresdefault.jpg
+    :alt: Atomic Calendar Revive and card_mod
+    :target: https://www.youtube.com/watch?v=-5MKd7LY-oc

_sources/contribute/bugs.rst.txt

@@ -0,0 +1,55 @@
+##############
+Reporting Bugs
+##############
+
+This section guides you through submitting a bug report for Atomic Calendar Revive.
+Following these guidelines helps maintainers and the community understand your report
+:pencil:, reproduce the behaviour :computer: :computer:, and find related reports
+:mag_right:.
+
+Before creating bug reports, please check the below information as you might find out
+that you don't need to create one. When you are creating a bug report,
+please :ref:include as many details as possible:, the information it asks for helps
+us resolve issues faster.
+
+.. note:
+   If you find a **Closed** issue that seems like it is the same thing that you're
+   experiencing, open a new issue and include a link to the original issue in the
+   body of your new one.
+
+
+******************************
+Before Submitting A Bug Report
+******************************
+
+* **Check the :ref:`qucikstart`** You may have miss-configured the plugin and
+  this is resulting in the issue you see
+* **Check the :ref:`FAQs`** for a list of common questions and problems.
+* **Perform a `cursory search <https://github.com/marksie1988/atomic-calendar-revive/issues?q=is%3Aissue>`_**
+  to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to
+  the existing issue instead of opening a new one.
+
+*****************************
+How do i submit a bug report?
+*****************************
+
+Bugs are tracked as `GitHub issues <https://guides.github.com/features/issues/>`_.
+After you've determined this is not a configuration issue, create an issue on github
+and provide the following information by filling in `the template <https://github.com/marksie1988/atomic-calendar-revive/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D+>`_.
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+- **Use a clear and descriptive title** for the issue to identify the problem.
+- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you installed the plugin. When listing steps, **don't just say what you did, but explain how you did it**. For example, did you use the Lovelace Editor or do the change in YAML directly.
+- **Provide specific examples to demonstrate the steps**. Include screenshots, or copy/paste configuration snippets, which you use in those examples. If you're providing snippets in the issue, use `Markdown code blocks <https://help.github.com/articles/markdown-basics/#multiple-lines>`_.
+- **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour.
+- **Explain which behaviour you expected to see instead and why.**
+- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
+- **If Chrome's developer tools pane is showing errors**, include these in your report
+- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+
+Provide more context by answering these questions:
+
+- **Did the problem start happening recently** (e.g. after updating to a new version of HA / Atomic Calendar Revive) or was this always a problem?
+- If the problem started happening recently, **can you reproduce the problem in an older version of Atomic Calendar Revive?** What's the most recent version in which the problem doesn't happen? You can install older versions of Atomic Calendar Revive via HACS or from the releases page on github
+- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.